Sign in
Conversation

post/v1/conversation/voice/outbound

Request body

phoneNumberstring required

The phone number to call in E.164 format. If a customer ID is not provided, the customer will be looked up by phone number. If no customer is found, a new customer will be created.

brandIdstring

The ID of the brand to make the call from

customerIdstring

The ID of the customer to call. If not provided, the customer will be looked up by phone number. If no customer is found, a new customer will be created.

agentIdstring

The ID of the agent to use for the call. Cannot be combined with workflowId.

workflowIdstring

The ID of the workflow to use for the call. Cannot be combined with agentId.

channelConfigIdstring

The ID of the channel config to use for the call. If not provided, the first active voice channel config will be used.

inputDataobject

Input data to pass to workflows. Should include values for input fields defined by both the chosen opening workflow and - if configured - the voicemail detected workflow.

Example request

{
  "phoneNumber": "+61400000000"
}

Response

conversationIdstring required

The ID of the conversation that was created

Changes

Changed in 4 of the 52 revisions of this API.14

  • 0a5817fe60b911See the full diff
    • ▲

      removed the success response with the status 201

      response-success-status-removed

    • ○

      added the success response with the status 200

      response-success-status-added

  • 415fe1c233421See the full diff
    • ○

      added the new optional request property agentId

      new-optional-request-property

  • 9236be8d05b11See the full diff
    • ○

      added the new optional request property channelConfigId

      new-optional-request-property

  • b4f394f05daf1See the full diff
    • ○

      the endpoint scheme security lorikeetClientId AND lorikeetSignatureAuthV1 was removed from the API

      api-security-removed