8.12 Support Management

These endpoints enables all customer support services to be managed.

get

Fetch a support session

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Responses
get
/support/{orderId}
default

Successful closure of a chat session

post

Generate a support request for an order

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Responses
post
/support/{orderId}
default

Successful closure of a chat session

put

Update a chat session

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Responses
put
/support/{orderId}
default

Successful closure of a chat session

delete

Close a chat session

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Responses
delete
/support/{orderId}
default

Successful closure of a chat session

get

Fetch the agent to a support session

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Responses
get
/support/{orderId}/agent
default

Successful closure of a chat session

put

Update agent for a support request

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Body

Details of customer support

order_idstringOptional
callback_phonestring · phoneOptional
Responses
put
/support/{orderId}/agent
default

Successful closure of a chat session

delete

Remove an agent from a support request

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Responses
delete
/support/{orderId}/agent
default

Successful closure of a chat session

Last updated

Was this helpful?