Conversation API

Versão 0

The Vonage 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.

Baixar a especificação OpenAPI

conversation

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.

Operações disponíveis

List conversations

Please note that not all data is available in the list endpoint. Once you've identified the conversation you need to work with, use the GET /conversations/:id endpoint to fetch all of the conversation details

gethttps://api.nexmo.com/v0.3/conversations

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Consulta Parâmetros

date_start

string(dateTime)

exemplo2018-01-01 10:00:00

Return the records that occurred after this point in time.

date_end

string(dateTime)

exemplo2018-01-01 12:00:00

Return the records that occurred before this point in time.

page_size

number

Mín.1

Max100

Padrão10

exemplo10

Return this amount of records in the response

order

string

Padrãoasc

Return the records in ascending or descending order.

Deve ser uma das seguintes opções:ascdescASCDESC

cursor

string

The cursor to start returning results from.

You are not expected to provide this manually, but to follow the url provided in _links.next.href or _links.prev.href in the response which contains a cursor value.

Respostas
Tipo de conteúdo
application/json

page_size

number

Obrigatório

Mín.1

Max100

Padrão10

exemplo10

The amount of records returned in this response

_embedded

object

Obrigatório

A list of conversation objects. See the get details of a specific conversation response fields for a description of the nested objects

conversations

array

Obrigatório

List of conversations matching the provided filter

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

name

string

Max100

exemplocustomer_chat

Your internal conversation name. Must be unique

display_name

string

exemploCustomer Chat

The public facing name of the conversation

image_url

string(uri)

Max2048

exemplohttps://example.com/image.png

An image URL that you associate with the conversation

timestamp

object

created

string

exemplo2019-09-03T18:40:24.324Z

The time that the conversation was created

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

_links

object

Obrigatório

A series of links between resources in this API in the http://stateless.co/hal_specification.html.

first

object

href

string

exemplohttps://api.nexmo.com/v0.3/conversations?order=desc&page_size=10

self

object

Obrigatório

href

string

exemplo

https://api.nexmo.com/v0.3/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

object

href

string

exemplo

https://api.nexmo.com/v0.3/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

object

href

string

exemplo

https://api.nexmo.com/v0.3/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

Exemplo Resposta

{
   "page_size": 10,
   "_embedded": {
      "conversations": [
         {
            "id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
            "name": "customer_chat",
            "display_name": "Customer Chat",
            "image_url": "https://example.com/image.png",
            "timestamp": {
               "created": "2019-09-03T18:40:24.324Z"
            },
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a"
               }
            }
         }
      ]
   },
   "_links": {
      "first": {
         "href": "https://api.nexmo.com/v0.3/conversations?order=desc&page_size=10"
      },
      "self": {
         "href": "https://api.nexmo.com/v0.3/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
      },
      "next": {
         "href": "https://api.nexmo.com/v0.3/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
      },
      "prev": {
         "href": "https://api.nexmo.com/v0.3/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
      }
   }
}

Create a conversation

posthttps://api.nexmo.com/v0.3/conversations

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Corpo da solicitação
Tipo de conteúdo
application/json

name

string

Max100

exemplocustomer_chat

Your internal conversation name. Must be unique

display_name

string

exemploCustomer Chat

The public facing name of the conversation

image_url

string(uri)

Max2048

exemplohttps://example.com/image.png

An image URL that you associate with the conversation

properties

object

Conversation properties

ttl

number

exemplo60

Time to leave. After how many seconds an empty conversation is deleted.

type

string

custom_data

object

numbers

array

exemplo

[
  {
    "type": "phone",
    "number": "447700900000"
  },
  {
    "type": "sip",
    "uri": "sip:+Htg:;xa",
    "username": "string",
    "password": "string"
  },
  {
    "type": "app",
    "user": "string"
  },
  {
    "type": "websocket",
    "uri": "ws://example.com:8080",
    "content_type": "string"
  },
  {
    "type": "vbc",
    "extension": "447700900000"
  }
]

An array containing number on different channels.

callback

object

url

string(uri)

event_mask

string

params

object

applicationId

string

ncco_url

string(uri)

method

string

Deve ser uma das seguintes opções:POSTGET

Exemplo Solicitação

{
   "name": "customer_chat",
   "display_name": "Customer Chat",
   "image_url": "https://example.com/image.png",
   "properties": {
      "ttl": 60,
      "type": "string",
      "custom_data": {
         "property1": "string",
         "property2": "string"
      }
   },
   "numbers": [
      {
         "type": "phone",
         "number": "447700900000"
      },
      {
         "type": "sip",
         "uri": "sip:+Htg:;xa",
         "username": "string",
         "password": "string"
      },
      {
         "type": "app",
         "user": "string"
      },
      {
         "type": "websocket",
         "uri": "ws://example.com:8080",
         "content_type": "string"
      },
      {
         "type": "vbc",
         "extension": "447700900000"
      }
   ],
   "callback": {
      "url": "http://example.com",
      "event_mask": "string",
      "params": {
         "applicationId": "string",
         "ncco_url": "http://example.com"
      },
      "method": "POST"
   }
}

Respostas
Tipo de conteúdo
application/json

Created

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

name

string

Max100

exemplocustomer_chat

Your internal conversation name. Must be unique

display_name

string

exemploCustomer Chat

The public facing name of the conversation

image_url

string(uri)

Max2048

exemplohttps://example.com/image.png

An image URL that you associate with the conversation

state

string

exemploACTIVE

The state the conversation is in.

sequence_number

integer

The last Event ID in this conversation. This ID can be used to retrieve a specific event.

timestamp

object

created

string

exemplo2019-09-03T18:40:24.324Z

The time that the conversation was created

properties

object

Conversation properties

ttl

number

exemplo60

Time to leave. After how many seconds an empty conversation is deleted.

type

string

custom_data

object

numbers

object

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

Exemplo Resposta

{
   "id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
   "name": "customer_chat",
   "display_name": "Customer Chat",
   "image_url": "https://example.com/image.png",
   "state": "ACTIVE",
   "sequence_number": 0,
   "timestamp": {
      "created": "2019-09-03T18:40:24.324Z"
   },
   "properties": {
      "ttl": 60,
      "type": "string",
      "custom_data": {
         "property1": "string",
         "property2": "string"
      }
   },
   "numbers": {},
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a"
      }
   }
}

Retrieve a conversation

gethttps://api.nexmo.com/v0.3/conversations/:conversation_id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

Respostas
Tipo de conteúdo
application/json

Retrieve a conversation

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

name

string

Max100

exemplocustomer_chat

Your internal conversation name. Must be unique

display_name

string

exemploCustomer Chat

The public facing name of the conversation

image_url

string(uri)

Max2048

exemplohttps://example.com/image.png

An image URL that you associate with the conversation

state

string

exemploACTIVE

The state the conversation is in.

sequence_number

integer

The last Event ID in this conversation. This ID can be used to retrieve a specific event.

timestamp

object

created

string

exemplo2019-09-03T18:40:24.324Z

The time that the conversation was created

properties

object

Conversation properties

ttl

number

exemplo60

Time to leave. After how many seconds an empty conversation is deleted.

type

string

custom_data

object

numbers

object

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

Exemplo Resposta

{
   "id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
   "name": "customer_chat",
   "display_name": "Customer Chat",
   "image_url": "https://example.com/image.png",
   "state": "ACTIVE",
   "sequence_number": 0,
   "timestamp": {
      "created": "2019-09-03T18:40:24.324Z"
   },
   "properties": {
      "ttl": 60,
      "type": "string",
      "custom_data": {
         "property1": "string",
         "property2": "string"
      }
   },
   "numbers": {},
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a"
      }
   }
}

Update a conversation

puthttps://api.nexmo.com/v0.3/conversations/:conversation_id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

Corpo da solicitação
Tipo de conteúdo
application/json

name

string

Max100

exemplocustomer_chat

Your internal conversation name. Must be unique

display_name

string

exemploCustomer Chat

The public facing name of the conversation

image_url

string(uri)

Max2048

exemplohttps://example.com/image.png

An image URL that you associate with the conversation

properties

object

Conversation properties

ttl

number

exemplo60

Time to leave. After how many seconds an empty conversation is deleted.

type

string

custom_data

object

numbers

array

exemplo

[
  {
    "type": "phone",
    "number": "447700900000"
  },
  {
    "type": "sip",
    "uri": "sip:+Htg:;xa",
    "username": "string",
    "password": "string"
  },
  {
    "type": "app",
    "user": "string"
  },
  {
    "type": "websocket",
    "uri": "ws://example.com:8080",
    "content_type": "string"
  },
  {
    "type": "vbc",
    "extension": "447700900000"
  }
]

An array containing number on different channels.

callback

object

url

string(uri)

event_mask

string

params

object

applicationId

string

ncco_url

string(uri)

method

string

Deve ser uma das seguintes opções:POSTGET

Exemplo Solicitação

{
   "name": "customer_chat",
   "display_name": "Customer Chat",
   "image_url": "https://example.com/image.png",
   "properties": {
      "ttl": 60,
      "type": "string",
      "custom_data": {
         "property1": "string",
         "property2": "string"
      }
   },
   "numbers": [
      {
         "type": "phone",
         "number": "447700900000"
      },
      {
         "type": "sip",
         "uri": "sip:+Htg:;xa",
         "username": "string",
         "password": "string"
      },
      {
         "type": "app",
         "user": "string"
      },
      {
         "type": "websocket",
         "uri": "ws://example.com:8080",
         "content_type": "string"
      },
      {
         "type": "vbc",
         "extension": "447700900000"
      }
   ],
   "callback": {
      "url": "http://example.com",
      "event_mask": "string",
      "params": {
         "applicationId": "string",
         "ncco_url": "http://example.com"
      },
      "method": "POST"
   }
}

Respostas
Tipo de conteúdo
application/json

Update a conversation

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

name

string

Max100

exemplocustomer_chat

Your internal conversation name. Must be unique

display_name

string

exemploCustomer Chat

The public facing name of the conversation

image_url

string(uri)

Max2048

exemplohttps://example.com/image.png

An image URL that you associate with the conversation

state

string

exemploACTIVE

The state the conversation is in.

sequence_number

integer

The last Event ID in this conversation. This ID can be used to retrieve a specific event.

timestamp

object

created

string

exemplo2019-09-03T18:40:24.324Z

The time that the conversation was created

properties

object

Conversation properties

ttl

number

exemplo60

Time to leave. After how many seconds an empty conversation is deleted.

type

string

custom_data

object

numbers

object

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

Exemplo Resposta

{
   "id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
   "name": "customer_chat",
   "display_name": "Customer Chat",
   "image_url": "https://example.com/image.png",
   "state": "ACTIVE",
   "sequence_number": 0,
   "timestamp": {
      "created": "2019-09-03T18:40:24.324Z"
   },
   "properties": {
      "ttl": 60,
      "type": "string",
      "custom_data": {
         "property1": "string",
         "property2": "string"
      }
   },
   "numbers": {},
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a"
      }
   }
}

Delete a conversation

deletehttps://api.nexmo.com/v0.3/conversations/:conversation_id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

Respostas

Success response with no content

user

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.

Operações disponíveis

List user conversations

gethttps://api.nexmo.com/v0.3/users/:user_id/conversations

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

user_id

string

Obrigatório

User ID

Consulta Parâmetros

state

string

Deve ser uma das seguintes opções:INVITEDJOINEDLEFT

date_start

string(dateTime)

exemplo2018-01-01 10:00:00

Return the records that occurred after this point in time.

page_size

number

Mín.1

Max100

Padrão10

exemplo10

Return this amount of records in the response

order

string

Padrãoasc

Return the records in ascending or descending order.

Deve ser uma das seguintes opções:ascdescASCDESC

cursor

string

The cursor to start returning results from.

You are not expected to provide this manually, but to follow the url provided in _links.next.href or _links.prev.href in the response which contains a cursor value.

Respostas
Tipo de conteúdo
application/json

page_size

number

Obrigatório

Mín.1

Max100

Padrão10

exemplo10

The amount of records returned in this response

_embedded

object

Obrigatório

A list of conversation objects. See the get details of a specific conversation response fields for a description of the nested objects

conversations

array

Obrigatório

List of conversations matching the provided filter

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

name

string

Max100

exemplocustomer_chat

Your internal conversation name. Must be unique

display_name

string

exemploCustomer Chat

The public facing name of the conversation

image_url

string(uri)

Max2048

exemplohttps://example.com/image.png

An image URL that you associate with the conversation

timestamp

object

created

string

exemplo2019-09-03T18:40:24.324Z

The time that the conversation was created

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

_links

object

Obrigatório

A series of links between resources in this API in the http://stateless.co/hal_specification.html.

self

object

Obrigatório

first

object

href

string

exemplohttps://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/conversations?order=desc&page_size=10

self

object

href

string

exemplo

https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

object

href

string

exemplo

https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

object

href

string

exemplo

https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

Exemplo Resposta

{
   "page_size": 10,
   "_embedded": {
      "conversations": [
         {
            "id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
            "name": "customer_chat",
            "display_name": "Customer Chat",
            "image_url": "https://example.com/image.png",
            "timestamp": {
               "created": "2019-09-03T18:40:24.324Z"
            },
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a"
               }
            }
         }
      ]
   },
   "_links": {
      "self": {
         "first": {
            "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/conversations?order=desc&page_size=10"
         },
         "self": {
            "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
         },
         "next": {
            "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
         },
         "prev": {
            "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/conversations?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
         }
      }
   }
}

List user sessions

gethttps://api.nexmo.com/v0.3/users/:user_id/sessions

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

user_id

string

Obrigatório

User ID

Consulta Parâmetros

page_size

number

Mín.1

Max100

Padrão10

exemplo10

Return this amount of records in the response

order

string

Padrãoasc

Return the records in ascending or descending order.

Deve ser uma das seguintes opções:ascdescASCDESC

cursor

string

The cursor to start returning results from.

You are not expected to provide this manually, but to follow the url provided in _links.next.href or _links.prev.href in the response which contains a cursor value.

Respostas
Tipo de conteúdo
application/json

page_size

number

Obrigatório

Mín.1

Max100

Padrão10

exemplo10

The amount of records returned in this response

_embedded

object

A list of session objects.

sessions

array

List of session matching the provided filter

string

Obrigatório

exemploSES-63f61863-4a51-4f6b-86e1-46edebio0391

_embedded

object

Obrigatório

user

object

Obrigatório

string

Obrigatório

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

name

string

Obrigatório

exemplomy_user_name

Unique name for a user

api_key

string

properties

object

Obrigatório

ttl

number(float)

Obrigatório

_links

object

A series of links between resources in this API in the http://stateless.co/hal_specification.html.

self

object

Obrigatório

first

object

href

string

exemplohttps://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/sessions?order=desc&page_size=10

self

object

href

string

exemplo

https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/sessions?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

object

href

string

exemplo

https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/sessions?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

object

href

string

exemplo

https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/sessions?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D

Exemplo Resposta

{
   "page_size": 10,
   "_embedded": {
      "sessions": [
         {
            "id": "SES-63f61863-4a51-4f6b-86e1-46edebio0391",
            "_embedded": {
               "user": {
                  "id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
                  "name": "my_user_name"
               },
               "api_key": "string"
            },
            "properties": {
               "ttl": 0
            }
         }
      ]
   },
   "_links": {
      "self": {
         "first": {
            "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/sessions?order=desc&page_size=10"
         },
         "self": {
            "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/sessions?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
         },
         "next": {
            "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/sessions?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
         },
         "prev": {
            "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec/sessions?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
         }
      }
   }
}

member

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.

Operações disponíveis

List members

gethttps://api.nexmo.com/v0.3/conversations/:conversation_id/members

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

Consulta Parâmetros

page_size

number

Mín.1

Max100

Padrão10

exemplo10

Return this amount of records in the response

order

string

Padrãoasc

Return the records in ascending or descending order.

Deve ser uma das seguintes opções:ascdescASCDESC

cursor

string

The cursor to start returning results from.

You are not expected to provide this manually, but to follow the url provided in _links.next.href or _links.prev.href in the response which contains a cursor value.

Respostas
Tipo de conteúdo
application/json

Members List Object

page_size

integer

exemplo10

The number of results returned on this page

_embedded

object

members

array

List of members matching the provided filter

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

state

string

exemploLEFT

The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN

Deve ser uma das seguintes opções:INVITEDJOINEDLEFTUNKNOWN

_embedded

object

user

object

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

name

string

exemplomy_user_name

Unique name for a user

display_name

string

exemploMy User Name

A string to be displayed as user name. It does not need to be unique

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec

_links

object

href

string(url)

exemplo

https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391

A link towards a member included in Conversation API

_links

object

first

object

href

string

exemplohttps://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a/members?order=desc&page_size=10

self

object

href

string

exemplo

https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a/members?order=desc&page_size=10&cursor=88b395c167da4d94e929705cbd63b82973771e7d390d274a58e301386d5762600a3ffd799bfb3fc5190c5a0d124cdd0fc72fe6e450506b18e4e2edf9fe84c7a0

object

href

string

exemplo

https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a/members?order=desc&page_size=10&cursor=88b395c167da4d94e929705cbd63b829a650e69a39197bfd4c949f4243f60dc4babb696afa404d2f44e7775e32b967f2a1a0bb8fb259c0999ba5a4e501eaab55

object

href

string

exemplo

https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a/members?order=desc&page_size=10&cursor=069626a3de11d2ec900dff5042197bd75f1ce41dafc3f2b2481eb9151086e59aae9dba3e3a8858dc355232d499c310fbfbec43923ff657c0de8d49ffed9f7edb

Exemplo Resposta

{
   "page_size": 10,
   "_embedded": {
      "members": [
         {
            "id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
            "state": "LEFT",
            "_embedded": {
               "user": {
                  "id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
                  "name": "my_user_name",
                  "display_name": "My User Name",
                  "_links": {
                     "self": {
                        "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
                     }
                  }
               }
            },
            "_links": {
               "href": "https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
            }
         }
      ]
   },
   "_links": {
      "first": {
         "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a/members?order=desc&page_size=10"
      },
      "self": {
         "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a/members?order=desc&page_size=10&cursor=88b395c167da4d94e929705cbd63b82973771e7d390d274a58e301386d5762600a3ffd799bfb3fc5190c5a0d124cdd0fc72fe6e450506b18e4e2edf9fe84c7a0"
      },
      "next": {
         "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a/members?order=desc&page_size=10&cursor=88b395c167da4d94e929705cbd63b829a650e69a39197bfd4c949f4243f60dc4babb696afa404d2f44e7775e32b967f2a1a0bb8fb259c0999ba5a4e501eaab55"
      },
      "prev": {
         "href": "https://api.nexmo.com/v0.3/conversations/CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a/members?order=desc&page_size=10&cursor=069626a3de11d2ec900dff5042197bd75f1ce41dafc3f2b2481eb9151086e59aae9dba3e3a8858dc355232d499c310fbfbec43923ff657c0de8d49ffed9f7edb"
      }
   }
}

Create a member

posthttps://api.nexmo.com/v0.3/conversations/:conversation_id/members

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

Corpo da solicitação
Tipo de conteúdo
application/json

state

string

exemploinvited

Invite or join a member to a conversation

Deve ser uma das seguintes opções:invitedjoined

user

object

Either the user id or name is required.

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

name

string

exemplomy_user_name

Unique name for a user

channel

object

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

type

string

exemplophone

Channel type

Deve ser uma das seguintes opções:appphonesipwebsocketvbc

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

from

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

leg_ids

array

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.

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

media

object

Media Object

knocking_id

string

exemploa972836a-450f-35fa-156c-52a2ab5b7d25

Knocker ID. A knocker is a pre-member of a conversation who does not exist yet

member_id_inviting

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID of the member that sends the invitation

Exemplo Solicitação

{
   "state": "invited",
   "user": {
      "id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
      "name": "my_user_name"
   },
   "channel": {
      "type": "phone",
      "leg_id": "a595959595959595995",
      "from": {
         "type": "app",
         "user": "jamie"
      },
      "to": {
         "type": "app",
         "user": "jamie"
      },
      "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"
}

Respostas
Tipo de conteúdo
application/json

Create a member

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

conversation_id

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

_embedded

object

user

object

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

name

string

exemplomy_user_name

Unique name for a user

display_name

string

exemploMy User Name

A string to be displayed as user name. It does not need to be unique

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec

state

string

exemplo

[
  "LEFT",
  "INVITED"
]

The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN

Deve ser uma das seguintes opções:INVITEDJOINEDLEFTUNKNOWN

timestamp

object

invited

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

joined

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

left

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

initiator

object

joined

object

isSystem

boolean

true if the user was invited by an admin JWT. user_id and member_id will not exist if true

user_id

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

member_id

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

channel

object

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

type

string

exemplophone

Channel type

Deve ser uma das seguintes opções:appphonesipwebsocketvbc

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

from

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

leg_ids

array

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.

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

media

object

exemplo

{
  "audio_settings": {
    "enabled": false,
    "earmuffed": false,
    "muted": false
  }
}

Media Object

_links

object

href

string(url)

exemplo

https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391

A link towards a member included in Conversation API

Exemplo Resposta

{
   "id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
   "conversation_id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
   "_embedded": {
      "user": {
         "id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
         "name": "my_user_name",
         "display_name": "My User Name",
         "_links": {
            "self": {
               "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
            }
         }
      }
   },
   "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": true,
         "user_id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
         "member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
      }
   },
   "channel": {
      "type": "phone",
      "leg_id": "a595959595959595995",
      "from": {
         "type": "app",
         "user": "jamie"
      },
      "to": {
         "type": "app",
         "user": "jamie"
      },
      "leg_ids": [
         {
            "leg_id": "a595959595959595995"
         }
      ]
   },
   "media": {
      "audio_settings": {
         "enabled": false,
         "earmuffed": false,
         "muted": false
      }
   },
   "_links": {
      "href": "https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
   }
}

Retrieve yourself in a given conversation

gethttps://api.nexmo.com/v0.3/conversations/:conversation_id/members/me

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

Respostas
Tipo de conteúdo
application/json

Retrieve member payload

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

conversation_id

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

_embedded

object

user

object

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

name

string

exemplomy_user_name

Unique name for a user

display_name

string

exemploMy User Name

A string to be displayed as user name. It does not need to be unique

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec

state

string

exemplo

[
  "LEFT",
  "JOINED"
]

The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN

Deve ser uma das seguintes opções:INVITEDJOINEDLEFTUNKNOWN

timestamp

object

invited

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

joined

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

left

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

initiator

object

joined

object

isSystem

boolean

true if the user was invited by an admin JWT. user_id and member_id will not exist if true

user_id

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

member_id

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

channel

object

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

type

string

exemplophone

Channel type

Deve ser uma das seguintes opções:appphonesipwebsocketvbc

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

from

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

leg_ids

array

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.

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

media

object

exemplo

{
  "audio_settings": {
    "enabled": false,
    "earmuffed": false,
    "muted": false
  }
}

Media Object

_links

object

href

string(url)

exemplo

https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391

A link towards a member included in Conversation API

Exemplo Resposta

{
   "id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
   "conversation_id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
   "_embedded": {
      "user": {
         "id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
         "name": "my_user_name",
         "display_name": "My User Name",
         "_links": {
            "self": {
               "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
            }
         }
      }
   },
   "state": "JOINED",
   "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": true,
         "user_id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
         "member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
      }
   },
   "channel": {
      "type": "phone",
      "leg_id": "a595959595959595995",
      "from": {
         "type": "app",
         "user": "jamie"
      },
      "to": {
         "type": "app",
         "user": "jamie"
      },
      "leg_ids": [
         {
            "leg_id": "a595959595959595995"
         }
      ]
   },
   "media": {
      "audio_settings": {
         "enabled": false,
         "earmuffed": false,
         "muted": false
      }
   },
   "_links": {
      "href": "https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
   }
}

Retrieve a member

gethttps://api.nexmo.com/v0.3/conversations/:conversation_id/members/:member_id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

member_id

string

Obrigatório

Member ID

Respostas
Tipo de conteúdo
application/json

Retrieve member payload

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

conversation_id

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

_embedded

object

user

object

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

name

string

exemplomy_user_name

Unique name for a user

display_name

string

exemploMy User Name

A string to be displayed as user name. It does not need to be unique

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec

state

string

exemplo

[
  "LEFT",
  "JOINED"
]

The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN

Deve ser uma das seguintes opções:INVITEDJOINEDLEFTUNKNOWN

timestamp

object

invited

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

joined

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

left

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

initiator

object

joined

object

isSystem

boolean

true if the user was invited by an admin JWT. user_id and member_id will not exist if true

user_id

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

member_id

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

channel

object

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

type

string

exemplophone

Channel type

Deve ser uma das seguintes opções:appphonesipwebsocketvbc

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

from

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

leg_ids

array

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.

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

media

object

exemplo

{
  "audio_settings": {
    "enabled": false,
    "earmuffed": false,
    "muted": false
  }
}

Media Object

_links

object

href

string(url)

exemplo

https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391

A link towards a member included in Conversation API

Exemplo Resposta

{
   "id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
   "conversation_id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
   "_embedded": {
      "user": {
         "id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
         "name": "my_user_name",
         "display_name": "My User Name",
         "_links": {
            "self": {
               "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
            }
         }
      }
   },
   "state": "JOINED",
   "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": true,
         "user_id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
         "member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
      }
   },
   "channel": {
      "type": "phone",
      "leg_id": "a595959595959595995",
      "from": {
         "type": "app",
         "user": "jamie"
      },
      "to": {
         "type": "app",
         "user": "jamie"
      },
      "leg_ids": [
         {
            "leg_id": "a595959595959595995"
         }
      ]
   },
   "media": {
      "audio_settings": {
         "enabled": false,
         "earmuffed": false,
         "muted": false
      }
   },
   "_links": {
      "href": "https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
   }
}

Update a member

Setting the state to left will result in the member leaving the conversation.

patchhttps://api.nexmo.com/v0.3/conversations/:conversation_id/members/:member_id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

member_id

string

Obrigatório

Member ID

Corpo da solicitação
Tipo de conteúdo
application/json

state

string

exemplojoined

Deve ser uma das seguintes opções:joinedleft

channel

object

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

type

string

exemplophone

Channel type

Deve ser uma das seguintes opções:appphonesipwebsocketvbc

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

from

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

leg_ids

array

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.

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

Exemplo Solicitação

{
   "state": "joined",
   "channel": {
      "type": "phone",
      "leg_id": "a595959595959595995",
      "from": {
         "type": "app",
         "user": "jamie"
      },
      "to": {
         "type": "app",
         "user": "jamie"
      },
      "leg_ids": [
         {
            "leg_id": "a595959595959595995"
         }
      ]
   }
}

Respostas
Tipo de conteúdo
application/json

Member updated

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

conversation_id

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

_embedded

object

user

object

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

name

string

exemplomy_user_name

Unique name for a user

display_name

string

exemploMy User Name

A string to be displayed as user name. It does not need to be unique

_links

object

self

object

href

string

exemplohttps://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec

state

string

exemplo

[
  "LEFT",
  "JOINED"
]

The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN

Deve ser uma das seguintes opções:INVITEDJOINEDLEFTUNKNOWN

timestamp

object

invited

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

joined

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

left

string

exemplo2020-01-01T14:00:00.00Z

Timestamp

initiator

object

joined

object

isSystem

boolean

true if the user was invited by an admin JWT. user_id and member_id will not exist if true

user_id

string

exemploUSR-82e028d9-5201-4f1e-8188-604b2d3471ec

User ID

member_id

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

channel

object

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

type

string

exemplophone

Channel type

Deve ser uma das seguintes opções:appphonesipwebsocketvbc

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

from

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

Um dos

type

string

Obrigatório

exemploapp

The type of connection. Must be app

user

string

Obrigatório

exemplojamie

The username to connect to

leg_ids

array

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.

leg_id

string

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

media

object

exemplo

{
  "audio_settings": {
    "enabled": false,
    "earmuffed": false,
    "muted": false
  }
}

Media Object

_links

object

href

string(url)

exemplo

https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391

A link towards a member included in Conversation API

Exemplo Resposta

{
   "id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
   "conversation_id": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
   "_embedded": {
      "user": {
         "id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
         "name": "my_user_name",
         "display_name": "My User Name",
         "_links": {
            "self": {
               "href": "https://api.nexmo.com/v0.3/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
            }
         }
      }
   },
   "state": "JOINED",
   "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": true,
         "user_id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
         "member_id": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
      }
   },
   "channel": {
      "type": "phone",
      "leg_id": "a595959595959595995",
      "from": {
         "type": "app",
         "user": "jamie"
      },
      "to": {
         "type": "app",
         "user": "jamie"
      },
      "leg_ids": [
         {
            "leg_id": "a595959595959595995"
         }
      ]
   },
   "media": {
      "audio_settings": {
         "enabled": false,
         "earmuffed": false,
         "muted": false
      }
   },
   "_links": {
      "href": "https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/members/MEM-63f61863-4a51-4f6b-86e1-46edebio0391"
   }
}

event

Events are actions that occur within a conversation. Examples of this includes: Text events from members, or invite events from users

Operações disponíveis

List events

gethttps://api.nexmo.com/v0.3/conversations/:conversation_id/events

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

Consulta Parâmetros

page_size

number

Mín.1

Max100

Padrão10

exemplo10

Return this amount of records in the response

order

string

Padrãoasc

Return the records in ascending or descending order.

Deve ser uma das seguintes opções:ascdescASCDESC

cursor

string

The cursor to start returning results from.

You are not expected to provide this manually, but to follow the url provided in _links.next.href or _links.prev.href in the response which contains a cursor value.

start_id

string

The ID to start returning events at

end_id

string

The ID to end returning events at

event_type

string

The type of event to search for. Does not currently support custom events

Respostas
Tipo de conteúdo
application/json

Retrieve Events Response Payload Object

page_size

integer

Obrigatório

exemplo10

The number of results returned on this page.

_embedded

object

Obrigatório

events

array

List of events matching the provided filter

string

Obrigatório

exemplo5

Event id. This is a progressive integer

type

string

Obrigatório

exemplotext

Event type

from

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

body

object

Obrigatório

exemplo

{
  "text": "My Text"
}

Event Body

state

string

exemploLEFT

The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN

Deve ser uma das seguintes opções:INVITEDJOINEDLEFTUNKNOWN

timestamp

string

Obrigatório

exemplo2020-01-01T14:00:00.00Z

Time of creation

href

string(url)

Obrigatório

exemplohttps://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1

A link towards a conversation event included in Conversation API

_links

object

Obrigatório

first

object

href

string

exemplohttps://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10

self

object

Obrigatório

href

string

exemplo

https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=a30e3b7a3dcda1434f64bbb1a5fa489b

object

href

string

exemplo

https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=4db03d9254d1cdaecc7b1fc15b6bf1a81f3d3151191d784f1327893f8dc96416

object

href

string

exemplo

https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=84963f79fd25785be9706bd38bfd30c264f71964fa4edc8d8b4dd5f30bbd9f7c

Exemplo Resposta

{
   "page_size": 10,
   "_embedded": {
      "events": [
         {
            "id": "5",
            "type": "text",
            "from": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
            "to": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
            "body": {
               "text": "My Text"
            },
            "state": "LEFT",
            "timestamp": "2020-01-01T14:00:00.00Z",
            "href": "https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1"
         }
      ]
   },
   "_links": {
      "first": {
         "href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10"
      },
      "self": {
         "href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=a30e3b7a3dcda1434f64bbb1a5fa489b"
      },
      "next": {
         "href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=4db03d9254d1cdaecc7b1fc15b6bf1a81f3d3151191d784f1327893f8dc96416"
      },
      "prev": {
         "href": "https://api.nexmo.com/v0.2/conversations/CON-92a44c64-7e4e-485f-a0c4-1f2adfc44625/events?page_size=10&cursor=84963f79fd25785be9706bd38bfd30c264f71964fa4edc8d8b4dd5f30bbd9f7c"
      }
   }
}

Create an event

posthttps://api.nexmo.com/v0.3/conversations/:conversation_id/events

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

Corpo da solicitação
Tipo de conteúdo
application/json

type

string

Obrigatório

exemplotext

Event type

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

from

string

Obrigatório

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

body

object

exemplo

{
  "text": "My Text"
}

Event Body

Exemplo Solicitação

{
   "type": "text",
   "to": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
   "from": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
   "body": {
      "text": "My Text"
   }
}

Respostas
Tipo de conteúdo
application/json

Create New Event Response Payload Object

string

exemplo5

Event id. This is a progressive integer

timestamp

string

exemplo2020-01-01T14:00:00.00Z

Time of event creation

href

string(url)

exemplohttps://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1

A link towards a conversation event included in Conversation API

Exemplo Resposta

{
   "id": "5",
   "timestamp": "2020-01-01T14:00:00.00Z",
   "href": "https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1"
}

Retrieve an event

gethttps://api.nexmo.com/v0.3/conversations/:conversation_id/events/:event_id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

event_id

string

Obrigatório

Event ID

Respostas
Tipo de conteúdo
application/json

Retrieve an event Content Payload

string

Obrigatório

exemplo5

Event id. This is a progressive integer

type

string

Obrigatório

exemplotext

Event type

from

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

string

exemploMEM-63f61863-4a51-4f6b-86e1-46edebio0391

Member ID

body

object

Obrigatório

exemplo

{
  "text": "My Text"
}

Event Body

state

string

exemploLEFT

The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN

Deve ser uma das seguintes opções:INVITEDJOINEDLEFTUNKNOWN

timestamp

string

Obrigatório

exemplo2020-01-01T14:00:00.00Z

Time of creation

href

string(url)

Obrigatório

exemplohttps://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1

A link towards a conversation event included in Conversation API

Exemplo Resposta

{
   "id": "5",
   "type": "text",
   "from": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
   "to": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391",
   "body": {
      "text": "My Text"
   },
   "state": "LEFT",
   "timestamp": "2020-01-01T14:00:00.00Z",
   "href": "https://api.nexmo.com/v0.3/conversations/CON-63f61863-4a51-4f6b-86e1-46edebio0391/events/1"
}

Delete an event

deletehttps://api.nexmo.com/v0.3/conversations/:conversation_id/events/:event_id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

conversation_id

string

Obrigatório

Conversation ID

event_id

string

Obrigatório

Event ID

Respostas
Tipo de conteúdo
application/json

Success response with empty JSON

Exemplo Resposta

{}

leg

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.

Operações disponíveis

List legs

gethttps://api.nexmo.com/v0.3/legs

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Respostas
Tipo de conteúdo
application/json

List Legs Successfully

count

number

Obrigatório

exemplo100

The total number of records returned by your request.

page_size

number

Obrigatório

Mín.1

Max100

Padrão10

exemplo10

The amount of records returned in this response

record_index

number

Obrigatório

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.

_links

object

Obrigatório

self

object

Obrigatório

href

string

_embedded

object

Obrigatório

A list of conversation objects. See the get details of a specific conversation response fields for a description of the nested objects

legs

array

Obrigatório

uuid

string

Obrigatório

exemploa595959595959595995

The id of the leg. rtc_id and call_id are leg id

type

string

exemplophone

Channel type

Deve ser uma das seguintes opções:appphonesipwebsocketvbc

conversation_uuid

string

exemploCON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a

The unique identifier for this conversation

state

string

exemploterminated

Leg Status

Deve ser uma das seguintes opções:terminated

from

object

start_time

string

exemplo2020-01-01T14:00:00.00Z

Time of leg start

start_end

string

exemplo2020-01-01T14:00:00.00Z

Time of leg end

_links

object

_embedded

object

Exemplo Resposta

{
   "count": "100",
   "page_size": 10,
   "record_index": 0,
   "_links": {
      "self": {
         "href": "string"
      }
   },
   "_embedded": {
      "legs": [
         {
            "uuid": "a595959595959595995",
            "type": "phone",
            "conversation_uuid": "CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a",
            "state": "terminated",
            "from": {},
            "to": {},
            "start_time": "2020-01-01T14:00:00.00Z",
            "start_end": "2020-01-01T14:00:00.00Z",
            "_links": {},
            "_embedded": {}
         }
      ]
   }
}

Delete a leg

deletehttps://api.nexmo.com/v0.3/legs/:leg_id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Seu token JSON da Web. Saiba mais sobre os JWTs	Headers	`Bearer <JWT>`

Caminho Parâmetros

leg_id

string

Obrigatório

Leg ID

Respostas
Tipo de conteúdo
application/json

Success response with empty JSON

Exemplo Resposta

{}

Conversation API

conversation

Operações disponíveis

List conversations

Autenticação

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Create a conversation

Autenticação

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Retrieve a conversation

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Update a conversation

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Delete a conversation

Autenticação

Caminho Parâmetros

Respostas

user

Operações disponíveis

List user conversations

Autenticação

Caminho Parâmetros

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

List user sessions

Autenticação

Caminho Parâmetros

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

member

Operações disponíveis

List members

Autenticação

Caminho Parâmetros

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Create a member

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Retrieve yourself in a given conversation

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Retrieve a member

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Update a member

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

event

Operações disponíveis

List events

Autenticação

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json