Create outbound call conversation
Use this method to create a conversation associated with an outbound call. Expected usage is to trigger this endpoint and then start a call using the RTC SDK callConversations method. The created conversation ID is required when using the callConversations method to trigger an outbound call. Another option is to use the ID of a previously created call conversation. More info.
Authorizations:
Scopes:
Request Body schema:
application/jsonfrom required | string DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint. |
to required | string Destination number. |
agentId required | string Id of the agent originating the call. |
voiceClientType | string Default: "PSTN" Enum: "PSTN" "WEBRTC" "WHATSAPP" "VIBER" Voice client type of the destination number. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
{- "from": "385998779621",
- "to": "38761123123",
- "agentId": "2010EA93ABC142E812C19F529BCBD22F",
- "voiceClientType": "PSTN"
}
Response samples
- 200
- 400
- 401
- 403
- 500
Successful response
{- "from": "385998779621",
- "to": "38761123333",
- "conversationId": "718A037A2FE0D2D5AA2D12A7240ED8C4",
- "agentId": "2010EA93ABC142E812C19F529BCBD22F"
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See