Suggestions

close search

Make call to an agent, then connect the call to a phone number when it is answered by the agent

URL: https://icc-api.stringee.com/v1/call/callout

HTTP method: POST

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

POST data (body):

{
    "agentUserId": "USER_ID",
    "toAgentFromNumberDisplay": "Call-out-from-842473082686",
    "toAgentFromNumberDisplayAlias": "Call-out-from-842473082686-Alias",
    "toCustomerFromNumber": "STRINGEE_NUMBER",
    "customerNumber": "CUSTOMER_NUMBER"
}

Field	Type	Require	Default	Description
agentUserId	String	YES		Agent's stringee_user_id
toAgentFromNumberDisplay	String	YES		The number will be shown to the agent
toAgentFromNumberDisplayAlias	String	YES		Alias of the number will be shown to the agent
toCustomerFromNumber	String	YES		Customer's phone number
customerNumber	String	YES		The number will be shown to the customer

Response:

{
    "r": RESULT_CODE,
    "message": "RESULT_MSG"
}

Field	Type	Require	Description
r	Int	Yes	Result code
message	String	No	Result message

Sample request

POST /v1/call/callout HTTP/1.1
Host: https://icc-api.stringee.com/v1/call/callout
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "agentUserId": "huy",
    "toAgentFromNumberDisplay": "Call-out-from-842473082686",
    "toAgentFromNumberDisplayAlias": "Call-out-from-842473082686-Alias",
    "toCustomerFromNumber": "84899199586",
    "customerNumber": "84909982888"
}

Sample response

{
    "r": 0,
    "message": "success",
}