Skip to navigation
Management APIReferenceSmartQueue

SQ_SetAgentCustomStatusMapping

View as Markdown

Adds a status if there is no match for the given internal status and renames it if there is a match. It means that if the passed sq_status_name parameter is not in the mapping table, a new entry is created in there; if it is, the name field in its mapping is replaced with custom_status_name.

Example request: Add/rename a status depending on the presence of an internal status in agent_status_mapping.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

sq_status_namestringRequired
Status name
custom_status_namestringRequired
Custom status name
application_idintegerRequired
Application ID

Response

Successful response
resultintegerOptional
Returns 1 if the request has been completed successfully