The Conversation API enables you to build conversation features where communication can take place across multiple mediums including IP Messaging, PSTN Voice, SMS and WebRTC Audio and Video. The context of the conversations is maintained though each communication event taking place within a conversation, no matter the medium.
A conversation is a shared core component that Vonage APIs rely on. Conversations happen over multiple mediums and and can have associated Users through Memberships.
The concept of a user exists in Vonage APIs, you can associate one with a user in your own application if you choose. A user can have multiple memberships to conversations and can communicate with other users through various different mediums.
Memberships connect users with conversations. Each membership has one conversation and one user however a user can have many memberships to conversations just as conversations can have many members.
Events are actions that occur within a conversation. Examples of this includes: Text events from members, or invite events from users
A leg can be a video call, IP call, or PSTN call that users participate in using multiple platforms. With this endpoint you can retrieve the details about all of the legs that took place in your application.
A conversation is a shared core component that Vonage APIs rely on. Conversations happen over multiple mediums and and can have associated Users through Memberships.
This endpoint is DEPRECATED. Please use /v0.2/conversations.
List all conversations associated with your application. This endpoint required an admin JWT. To find all conversations for the currently logged in user, see GET /users/:id/conversations
GET
https://api.nexmo.com/v0.1/conversations
Host
https://api.nexmo.com
GET
/v0.1/conversations
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Return the records that occurred after this point in time.
Return the records that occurred before this point in time.
Return this amount of records in the response
Return calls from this index in the response
Return the records in ascending or descending order.
Must be one of:asc
, desc
, ASC
or DESC
The total number of records returned by your request.
The amount of records returned in this response
Return page_size
amount of conversations from this index in the response. That is, if your request returns 300 conversations, set record_index
to 5 in order to return conversations 50 to 59. The default value is 0. That is, the first page_size
calls.
A list of conversation objects. See the get details of a specific conversation response fields for a description of the nested objects
The unique identifier for this conversation
Unique name for a conversation
{
"count": "100",
"page_size": 50,
"record_index": 0,
"_links": {
"self": {
"href": "https://api.nexmo.com/v0.1/conversations?page_size=2&record_index=10&"
}
},
"_embedded": {
"conversations": [
{
"uuid": "CON-63f61863-4a51-4f6b-86e1-46edebio0391",
"name": "customer_chat",
"_links": {
"self": {
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391"
}
}
}
]
}
}
POST
https://api.nexmo.com/v0.1/conversations
Host
https://api.nexmo.com
POST
/v0.1/conversations
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation Request Payload Object
Unique name for a conversation
The display name for the conversation. It does not have to be unique
A link to an image for conversations' and users' avatars
Conversation properties
Time to leave. After how many seconds an empty conversation is deleted.
The unique identifier for this conversation
A link towards a conversation included in Conversation API
{
"name": "customer_chat",
"display_name": "Customer Chat",
"image_url": "https://example.com/image.png",
"properties": {
"ttl": 60
}
}
{
"id": "CON-63f61863-4a51-4f6b-86e1-46edebio0391",
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391"
}
PUT
https://api.nexmo.com/v0.1/conversations/:conversation_id
Host
https://api.nexmo.com
PUT
/v0.1/conversations/:conversation_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Conversation Request Payload Object
Unique name for a conversation
The display name for the conversation. It does not have to be unique
A link to an image for conversations' and users' avatars
Conversation properties
Time to leave. After how many seconds an empty conversation is deleted.
The unique identifier for this conversation
A link towards a conversation included in Conversation API
{
"name": "customer_chat",
"display_name": "Customer Chat",
"image_url": "https://example.com/image.png",
"properties": {
"ttl": 60
}
}
{
"id": "CON-63f61863-4a51-4f6b-86e1-46edebio0391",
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391"
}
GET
https://api.nexmo.com/v0.1/conversations/:conversation_id
Host
https://api.nexmo.com
GET
/v0.1/conversations/:conversation_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
The unique identifier for this conversation
Unique name for a conversation
The display name for the conversation. It does not have to be unique
Time of creation
Time of last update
Time of last update
The last Event ID in this conversation. This ID can be used to retrieve a specific event
Users associated to this conversation as members
Member ID
User ID
Unique name for a user
The state that the member is in. Possible values are invited
, joined
, left
, or unknown
invited
, joined
, left
or unknown
Timestamp
Timestamp
Timestamp
true
if the user was invited by an admin JWT. user_id
and member_id
will not exist if true
User ID
Member ID
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
Channel type
One of:app
, phone
, sip
, websocket
or vbc
The id of the leg. rtc_id and call_id are leg id
Leg ids associated with this Channel. The first item in the array represents the main active Leg. The second item, if exists, represents a screen-share Leg.
The id of the leg. rtc_id and call_id are leg id
The API key for your account
{
"uuid": "CON-63f61863-4a51-4f6b-86e1-46edebio0391",
"name": "customer_chat",
"numbers": {},
"properties": {
"video": false
},
"display_name": "Customer Chat",
"timestamp": {
"created": "2020-01-01T14:00:00.00Z",
"updated": "2020-01-01T14:05:00.00Z",
"destroyed": "2020-01-01T14:20:00.00Z"
},
"sequence_number": "1",
"members": [
{
"member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"user_id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"name": "my_user_name",
"state": "invited",
"timestamp": {
"invited": "2020-01-01T14:00:00.00Z",
"joined": "2020-01-01T14:00:00.00Z",
"left": "2020-01-01T14:00:00.00Z"
},
"initiator": {
"joined": {
"isSystem": false,
"user_id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
}
},
"channel": {
"type": "phone",
"leg_id": "a595959595959595995",
"from": {},
"to": {},
"leg_ids": [
{
"leg_id": "a595959595959595995"
}
]
}
}
],
"api_key": "abc123",
"_links": {
"self": {
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391"
}
}
}
DELETE
https://api.nexmo.com/v0.1/conversations/:conversation_id
Host
https://api.nexmo.com
DELETE
/v0.1/conversations/:conversation_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
{}
PUT
https://api.nexmo.com/v1/conversations/:conversation_id/record
Host
https://api.nexmo.com
PUT
/v1/conversations/:conversation_id/record
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Record Conversation Request Payload Object
Recording Action
Must be one of:start
or stop
The webhook endpoint where recording progress events are sent to.
The HTTP method used to send event information to event_url.
Record the sent and received audio in separate channels of a stereo recording
Record the Conversation in a specific format.
Must be one of:mp3
or wav
{
"action": "start"
}
{
"action": "start",
"event_url": [
"https://example.com/event"
],
"event_method": "POST",
"split": "conversation",
"format": "mp3"
}
No Content
This endpoint does not support application/json
This endpoint does not support application/json
The concept of a user exists in Vonage APIs, you can associate one with a user in your own application if you choose. A user can have multiple memberships to conversations and can communicate with other users through various different mediums.
This endpoint is DEPRECATED. Please use /v0.2/users.
GET
https://api.nexmo.com/v0.1/users
Host
https://api.nexmo.com
GET
/v0.1/users
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
User ID
Unique name for a user
A link towards a user included in Conversation API
[
{
"id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"name": "my_user_name",
"href": "https://api.nexmo.com/v0.1/users/USR-63f61863-4a51-4f6b-86e1-46edebio0391"
}
]
Note: Users must be created with an admin JWT.
POST
https://api.nexmo.com/v0.1/users
Host
https://api.nexmo.com
POST
/v0.1/users
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Unique name for a user
A string to be displayed as user name. It does not need to be unique
A link to an image for conversations' and users' avatars
User ID
A link towards a user included in Conversation API
{
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png"
}
{
"id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"href": "https://api.nexmo.com/v0.1/users/USR-63f61863-4a51-4f6b-86e1-46edebio0391"
}
GET
https://api.nexmo.com/v0.1/users/:user_id
Host
https://api.nexmo.com
GET
/v0.1/users/:user_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
User ID
User ID
Unique name for a user
{
"id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"name": "my_user_name",
"href": "https://api.nexmo.com/v0.1/users/USR-63f61863-4a51-4f6b-86e1-46edebio0391"
}
PUT
https://api.nexmo.com/v0.1/users/:user_id
Host
https://api.nexmo.com
PUT
/v0.1/users/:user_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
User ID
Unique name for a user
A string to be displayed as user name. It does not need to be unique
A link to an image for conversations' and users' avatars
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
Channel type
Must be one of:app
, phone
, sip
, websocket
or vbc
The id of the leg. rtc_id and call_id are leg id
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
Leg ids associated with this Channel. The first item in the array represents the main active Leg. The second item, if exists, represents a screen-share Leg.
User ID
A link towards a user included in Conversation API
{
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png",
"channels": {
"type": "phone",
"leg_id": "a595959595959595995",
"leg_ids": [
{
"leg_id": "a595959595959595995"
}
]
}
}
{
"id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"href": "https://api.nexmo.com/v0.1/users/USR-63f61863-4a51-4f6b-86e1-46edebio0391"
}
DELETE
https://api.nexmo.com/v0.1/users/:user_id
Host
https://api.nexmo.com
DELETE
/v0.1/users/:user_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
User ID
{}
GET
https://api.nexmo.com/v0.1/users/:user_id/conversations
Host
https://api.nexmo.com
GET
/v0.1/users/:user_id/conversations
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
User ID
Unique name for a conversation
A link to an image for conversations' and users' avatars
The display name for the conversation. It does not have to be unique
The state that the member is in. Possible values are invited
, joined
, left
, or unknown
invited
, joined
, left
or unknown
Member ID
the id of the last event of the conversation (event's id is an incremental number
A link towards a resources included in Conversation API
The unique identifier for this conversation
Timestamp
[
{
"name": "customer_chat",
"image_url": "https://example.com/image.png",
"display_name": "Customer Chat",
"state": "invited",
"member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"sequence_number": "123",
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391",
"id": "CON-63f61863-4a51-4f6b-86e1-46edebio0391",
"timestamp": {
"created": "2020-01-01T14:00:00.00Z"
}
}
]
Memberships connect users with conversations. Each membership has one conversation and one user however a user can have many memberships to conversations just as conversations can have many members.
This endpoint is DEPRECATED. Please use /v0.2/members.
GET
https://api.nexmo.com/v0.1/conversations/:conversation_id/members
Host
https://api.nexmo.com
GET
/v0.1/conversations/:conversation_id/members
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
User ID
Unique name for a user
Unique name for a user
The state that the member is in. Possible values are invited
, joined
, left
, or unknown
invited
, joined
, left
or unknown
[
{
"user_id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"user_name": "my_user_name",
"name": "my_user_name",
"state": "invited"
}
]
POST
https://api.nexmo.com/v0.1/conversations/:conversation_id/members
Host
https://api.nexmo.com
POST
/v0.1/conversations/:conversation_id/members
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Invite or join a member to a conversation
Must be one of:invite
or join
User ID
Member ID
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
Channel type
Must be one of:app
, phone
, sip
, websocket
or vbc
The id of the leg. rtc_id and call_id are leg id
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
Leg ids associated with this Channel. The first item in the array represents the main active Leg. The second item, if exists, represents a screen-share Leg.
Media Object
Knocker ID. A knocker is a pre-member of a conversation who does not exist yet
Member ID of the member that sends the invitation
Member ID
User ID
The state that the member is in. Possible values are invited
, joined
, left
, or unknown
invited
, joined
, left
or unknown
Timestamp
Timestamp
Timestamp
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
Channel type
One of:app
, phone
, sip
, websocket
or vbc
The id of the leg. rtc_id and call_id are leg id
Leg ids associated with this Channel. The first item in the array represents the main active Leg. The second item, if exists, represents a screen-share Leg.
The id of the leg. rtc_id and call_id are leg id
A link towards a member included in Conversation API
true
if the user was invited by an admin JWT. user_id
and member_id
will not exist if true
User ID
Member ID
{
"user_id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391"
}
{
"action": "join",
"user_id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"channel": {
"type": "phone",
"leg_id": "a595959595959595995",
"leg_ids": [
{
"leg_id": "a595959595959595995"
}
]
},
"media": {
"audio_settings": {
"enabled": false,
"earmuffed": false,
"muted": false
}
},
"knocking_id": "a972836a-450f-35fa-156c-52a2ab5b7d25",
"member_id_inviting": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
}
{
"id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"user_id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"state": "invited",
"timestamp": {
"invited": "2020-01-01T14:00:00.00Z",
"joined": "2020-01-01T14:00:00.00Z",
"left": "2020-01-01T14:00:00.00Z"
},
"channel": {
"type": "phone",
"leg_id": "a595959595959595995",
"from": {},
"to": {},
"leg_ids": [
{
"leg_id": "a595959595959595995"
}
]
},
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"initiator": {
"joined": {
"isSystem": false,
"user_id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391",
"member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
}
}
}
GET
https://api.nexmo.com/v0.1/conversations/:conversation_id/members/:member_id
Host
https://api.nexmo.com
GET
/v0.1/conversations/:conversation_id/members/:member_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Member ID
Member ID
A link towards a member included in Conversation API
{
"id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
}
PUT
https://api.nexmo.com/v0.1/conversations/:conversation_id/members/:member_id
Host
https://api.nexmo.com
PUT
/v0.1/conversations/:conversation_id/members/:member_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Member ID
Invite or join a member to a conversation
Must be one of:invite
or join
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
Channel type
Must be one of:app
, phone
, sip
, websocket
or vbc
The id of the leg. rtc_id and call_id are leg id
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
A user who joins a conversation as a member can have one channel per membership type. Channels can be app
, phone
, sip
, websocket
, or vbc
Leg ids associated with this Channel. The first item in the array represents the main active Leg. The second item, if exists, represents a screen-share Leg.
Member ID
A link towards a member included in Conversation API
{
"action": "join",
"channel": {
"type": "phone",
"leg_id": "a595959595959595995",
"leg_ids": [
{
"leg_id": "a595959595959595995"
}
]
}
}
{
"id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
}
DELETE
https://api.nexmo.com/v0.1/conversations/:conversation_id/members/:member_id
Host
https://api.nexmo.com
DELETE
/v0.1/conversations/:conversation_id/members/:member_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Member ID
{}
Events are actions that occur within a conversation. Examples of this includes: Text events from members, or invite events from users
This endpoint is DEPRECATED. Please use /v0.2/events.
GET
https://api.nexmo.com/v0.1/conversations/:conversation_id/events
Host
https://api.nexmo.com
GET
/v0.1/conversations/:conversation_id/events
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Event id. This is a progressive integer
Event type
Member ID
Member ID
Event Body
The state that the member is in. Possible values are invited
, joined
, left
, or unknown
invited
, joined
, left
or unknown
Time of creation
A link towards a conversation event included in Conversation API
[
{
"id": "5",
"type": "text",
"from": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"to": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"body": {
"text": "My Text"
},
"state": "invited",
"timestamp": "2020-01-01T14:00:00.00Z",
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1"
}
]
POST
https://api.nexmo.com/v0.1/conversations/:conversation_id/events
Host
https://api.nexmo.com
POST
/v0.1/conversations/:conversation_id/events
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Event type
Member ID
Member ID
Event Body
Event id. This is a progressive integer
Time of event creation
A link towards a conversation event included in Conversation API
{
"type": "text",
"from": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
}
{
"type": "text",
"to": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"from": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"body": {
"text": "My Text"
}
}
{
"id": "5",
"timestamp": "2020-01-01T14:00:00.00Z",
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1"
}
GET
https://api.nexmo.com/v0.1/conversations/:conversation_id/events/:event_id
Host
https://api.nexmo.com
GET
/v0.1/conversations/:conversation_id/events/:event_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Event ID
Event id. This is a progressive integer
Event type
Member ID
Member ID
Event Body
The state that the member is in. Possible values are invited
, joined
, left
, or unknown
invited
, joined
, left
or unknown
Time of creation
A link towards a conversation event included in Conversation API
{
"id": "5",
"type": "text",
"from": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"to": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
"body": {
"text": "My Text"
},
"state": "invited",
"timestamp": "2020-01-01T14:00:00.00Z",
"href": "https://api.nexmo.com/v0.1/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1"
}
DELETE
https://api.nexmo.com/v0.1/conversations/:conversation_id/events/:event_id
Host
https://api.nexmo.com
DELETE
/v0.1/conversations/:conversation_id/events/:event_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Conversation ID
Event ID
{}
A leg can be a video call, IP call, or PSTN call that users participate in using multiple platforms. With this endpoint you can retrieve the details about all of the legs that took place in your application.
GET
https://api.nexmo.com/v0.1/legs
Host
https://api.nexmo.com
GET
/v0.1/legs
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
The total number of records returned by your request.
The amount of records returned in this response
Return page_size
amount of conversations from this index in the response. That is, if your request returns 300 conversations, set record_index
to 5 in order to return conversations 50 to 59. The default value is 0. That is, the first page_size
calls.
A list of conversation objects. See the get details of a specific conversation response fields for a description of the nested objects
The id of the leg. rtc_id and call_id are leg id
Channel type
One of:app
, phone
, sip
, websocket
or vbc
The unique identifier for this conversation
Leg Status
One of:terminated
Time of leg start
Time of leg end
{
"count": "100",
"page_size": 50,
"record_index": 0,
"_links": {
"self": {
"href": "abc123"
}
},
"_embedded": {
"legs": [
{
"uuid": "a595959595959595995",
"type": "phone",
"conversation_uuid": "CON-63f61863-4a51-4f6b-86e1-46edebio0391",
"state": "terminated",
"from": {},
"to": {},
"start_time": "2020-01-01T14:00:00.00Z",
"start_end": "2020-01-01T14:00:00.00Z",
"_links": {},
"_embedded": {}
}
]
}
}
DELETE
https://api.nexmo.com/v0.1/legs/:leg_id
Host
https://api.nexmo.com
DELETE
/v0.1/legs/:leg_id
Key | Description | Example | Default |
---|---|---|---|
Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
Leg ID
{}