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>"
    }
  ],
  "idleTimeoutMinutes": 2,
  "maxOpenMinutes": 2
}
'
{
  "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>",
    "actionsNeeded": [
      "<string>"
    ],
    "topic": "<string>",
    "duration": 1500,
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "status": "OPEN"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.helloannie.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
idleTimeoutMinutes
number

Optional. Auto-close the conversation after this many minutes with no inbound or outbound activity. Omit to disable the idle timeout (the conversation will remain open until the platform max is reached). Values larger than the platform max are clamped to the platform max.

Required range: x >= 1Must be a multiple of 1
​
maxOpenMinutes
number

Optional. Hard maximum for how long the conversation can stay open, measured from creation. Omit to allow the conversation to stay open up to the platform max. Values larger than the platform max are clamped to the platform max.

Required range: x >= 1Must be a multiple of 1

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