Skip to main content
POST
/
conversations
Create conversation
curl --request POST \
  --url https://api.helloannie.com/v1/conversations \
  --header 'Content-Type: application/json' \
  --data '
{
  "medium": "CHAT",
  "botId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "toNumber": "<string>",
  "messages": [
    {
      "role": "user",
      "input": "<string>"
    }
  ]
}
'
{
  "success": true,
  "data": {
    "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversationTags": [
      "<string>"
    ],
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "medium": "CHAT",
    "botId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "toNumber": "<string>",
    "fromNumber": "<string>",
    "summary": "<string>",
    "topic": "<string>",
    "duration": 1500,
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "status": "OPEN"
  }
}

Body

Request body for creating a new conversation

​
medium
enum<string>
required
Available options:
CHAT,
SMS
​
botId
string<uuid>
required

The ID of the bot to use for this conversation

​
toNumber
string

The phone number the conversation is to

​
messages
object[]

Initial messages to seed the conversation. Order is preserved.

Response

Response returned when creating a new conversation

​
success
enum<boolean>
required
Available options:
true
​
data
object
required

High-level information about a conversation including summary metadata