Sign in
Conversation

Create a new conversation request

DEPRECATED: Use POST /conversation/voice/create instead

post/v1/conversation/new

Headers

x-lorikeet-voice-public-keystring required

Request body

phoneNumberstring required

The phone number of the customer

publicKeystring required

The public key of your Telephony integration

remoteIdstring

The remoteId of your customer

firstNamestring

The first name of the customer

lastNamestring

The last name of the customer

emailstring

The email of the customer

stateobject required

The custom attributes of the customer - should be provided as key value object

Example request

{
  "phoneNumber": "0412745903",
  "publicKey": "your-telephony-public-key",
  "remoteId": "1234567890",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com"
}

Response

Create a new conversation request

conversationIdobject nullable required

The id of the conversation created. Null if ticket creation was skipped.

Changes