External Accounts API

The External Accounts API is used to manage accounts for Viber Business Messages, Facebook Messenger and Whatsapp for use in the Messages and Dispatch APIs.

Descargar la especificación OpenAPI

Application

Inbound messages to an external account which is linked to an application will be delivered to the application's inbound URL.

Operaciones disponibles

Link application to an account

posthttps://api.nexmo.com/beta/chatapp-accounts/:provider/:external_id/applications

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

provider

string

Requerido

Provider of the account you want to assign an application to

Debe ser uno de:messengerviber_service_msgwhatsapprcs

external_id

string

Requerido

External id of the account you want to assign an application to. This is channel dependent. For Facebook it will be your Facebook Page ID, for Viber your Viber Service Message ID and for WhatsApp your WhatsApp number, for RCS it will be the RCS Agent ID.

Cuerpo de la solicitud
Tipo de contenido
application/json

application

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

There is just one application allowed per an account. The application type must be type "messages". For more information please see Application API Spec

Ejemplo Solicitar

{
   "application": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
}

{
   "application": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
}

Respuestas
Tipo de contenido
application/json

OK.

name

string

ejemploname

The account name

applications

array

The array of associated application ids

external_id

string

Requerido

ejemplo12345678

The external identifier for this account

api_key

string

Requerido

ejemploabcd1234

The external api key for this account

provider

string

Requerido

ejemplomessenger

The provider (will be one of messenger, viber_service_msg, whatsapp, rcs).

Debe ser uno de:messengerviber_service_msgwhatsapprcs

access_token

string

ejemploaccessToken

The provider access token (only for messenger)

Ejemplo Respuesta

{
   "name": "name",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ],
   "external_id": "12345678",
   "api_key": "abcd1234",
   "provider": "messenger",
   "access_token": "accessToken"
}

Unlink application from an account

deletehttps://api.nexmo.com/beta/chatapp-accounts/:provider/:external_id/applications/:application_id

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

provider

string

Requerido

Provider of the account you want to unlink an application from

Debe ser uno de:messengerviber_service_msgwhatsapprcs

external_id

string

Requerido

External id of the account you want to unlink an application from

application_id

string

Requerido

Id of the application you want to unlink

Respuestas

No Content.

Account

An external-account used as the from field in the Messages API and Dispatch API

Operaciones disponibles

Retrieve all accounts you own

Retrieve all accounts you own

gethttps://api.nexmo.com/beta/chatapp-accounts/

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

provider

string

Filter by provider

Debe ser uno de:messengerviber_service_msgwhatsapp

page_number

integer

Por defecto1

ejemplo1

Page number of the results

page_size

integer

Por defecto20

ejemplo1

Page size of the results

Respuestas
Tipo de contenido
application/json

OK.

page_number

integer

ejemplo1

page_size

integer

ejemplo10

_embedded

array

name

string

ejemplooptionalName

The account name

applications

array

The array of associated application ids

external_id

string

Requerido

ejemplo12345678

The external identifier for this account

api_key

string

Requerido

ejemploabcd1234

The external api key for this account

provider

string

Requerido

ejemplo

[
  "messenger",
  "viber_service_msg",
  "whatsapp"
]

The provider (will be messenger).

access_token

string

Requerido

ejemplomyAccessToken

The provider access token

_links

object

self

object

href

string

ejemplohttps://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10

object

href

string

ejemplohttps://api.nexmo.com/beta/chatapp-accounts?page_number=3&page_size=10

object

href

string

ejemplohttps://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10

first

object

href

string

ejemplohttps://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10

last

object

href

string

ejemplohttps://api.nexmo.com/beta/chatapp-accounts?page_number=4&page_size=10

Ejemplo Respuesta

{
   "page_number": 1,
   "page_size": 10,
   "_embedded": [
      {
         "name": "optionalName",
         "applications": [
            "optionalApplicationId"
         ],
         "external_id": "12345678",
         "api_key": "abcd1234",
         "provider": "whatsapp",
         "access_token": "myAccessToken"
      }
   ],
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10"
      },
      "next": {
         "href": "https://api.nexmo.com/beta/chatapp-accounts?page_number=3&page_size=10"
      },
      "prev": {
         "href": "https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10"
      },
      "first": {
         "href": "https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10"
      },
      "last": {
         "href": "https://api.nexmo.com/beta/chatapp-accounts?page_number=4&page_size=10"
      }
   }
}

Facebook Messenger

Managing your Facebook Messenger account

Operaciones disponibles

Create a Messenger account

posthttps://api.nexmo.com/beta/chatapp-accounts/messenger

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

external_id

string

Requerido

ejemplo12345678

This is the unique identifier within the provider's domain. In this case it is the Page ID for your Facebook Page. Go to your Facebook Page, click "Settings", click "Messenger platform " scroll down to "Messenger link" to find your Page ID.

access_token

string

Requerido

ejemplomyAccessToken

This is the Facebook Business Page token. You can obtain the token using one of the following methods:

Linking your Facebook Business Page to your account with our Dashboard tool
Requesting a Page Access Token using the steps in the Facebook token reference

name

string

ejemplooptionalName

Custom account name

applications

array

Contains a list of application IDs which are linked to the account.

There is just one application allowed per an account.
The application type must be type "messages".

For more information see Application API spec

Ejemplo Solicitar

{
   "external_id": "12345678",
   "access_token": "myAccessToken",
   "name": "optionalName",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ]
}

{
   "external_id": "12345678",
   "access_token": "myAccessToken",
   "name": "optionalName",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ]
}

Respuestas
Tipo de contenido
application/json

Created.

name

string

ejemplooptionalName

The account name

applications

array

The array of associated application ids

external_id

string

Requerido

ejemplo12345678

The external identifier for this account

api_key

string

Requerido

ejemploabcd1234

The external api key for this account

provider

string

Requerido

ejemplomessenger

The provider (will be messenger).

access_token

string

Requerido

ejemplomyAccessToken

The provider access token

Ejemplo Respuesta

{
   "name": "optionalName",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ],
   "external_id": "12345678",
   "api_key": "abcd1234",
   "provider": "messenger",
   "access_token": "myAccessToken"
}

Retrieve a Messenger account

gethttps://api.nexmo.com/beta/chatapp-accounts/messenger/:external_id

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

external_id

string

Requerido

External id of the account you want to retrieve. In this case it is the Facebook Page ID.

Respuestas
Tipo de contenido
application/json

OK.

name

string

ejemplooptionalName

The account name

applications

array

The array of associated application ids

external_id

string

Requerido

ejemplo12345678

The external identifier for this account

api_key

string

Requerido

ejemploabcd1234

The external api key for this account

provider

string

Requerido

ejemplomessenger

The provider (will be messenger).

access_token

string

Requerido

ejemplomyAccessToken

The provider access token

Ejemplo Respuesta

{
   "name": "optionalName",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ],
   "external_id": "12345678",
   "api_key": "abcd1234",
   "provider": "messenger",
   "access_token": "myAccessToken"
}

Update a Messenger account

patchhttps://api.nexmo.com/beta/chatapp-accounts/messenger/:external_id

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

external_id

string

Requerido

External id of the account you want to update. In this case it is the Facebook Page ID.

Cuerpo de la solicitud
Tipo de contenido
application/json

name

string

ejemplonewName

The new account name

applications

array

access_token

string

ejemploupdatedAccessToken

Ejemplo Solicitar

{
   "name": "newName",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ],
   "access_token": "updatedAccessToken"
}

{
   "name": "newName",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ],
   "access_token": "updatedAccessToken"
}

Respuestas
Tipo de contenido
application/json

OK.

name

string

ejemplonewName

The account name

applications

array

The array of associated application ids

external_id

string

Requerido

ejemplo12345678

The external identifier for this account. In this case it is the Facebook Page ID.

api_key

string

Requerido

ejemploabcd1234

The external api key for this account

provider

string

Requerido

ejemplomessenger

The provider (will be messenger).

access_token

string

Requerido

ejemploupdatedAccessToken

The provider access token

Ejemplo Respuesta

{
   "name": "newName",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ],
   "external_id": "12345678",
   "api_key": "abcd1234",
   "provider": "messenger",
   "access_token": "updatedAccessToken"
}

Delete a Messenger account

deletehttps://api.nexmo.com/beta/chatapp-accounts/messenger/:external_id

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

external_id

string

Requerido

External id of the account you want to delete. In this case it is the Facebook Page ID.

Respuestas

No Content.

Viber Service Message

Managing your Viber Service Message account

Operaciones disponibles

Retrieve a Viber Service Message account

Retrieve a Viber Service Message account

gethttps://api.nexmo.com/beta/chatapp-accounts/viber_service_msg/:external_id

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

external_id

string

Requerido

External id of the account you want to retrieve. In this case it will be your Viber Service Message ID.

Respuestas
Tipo de contenido
application/json

OK.

name

string

ejemplooptionalName

The account name

applications

array

The array of associated application ids

external_id

string

Requerido

ejemplo12345678

The external identifier for this account

api_key

string

Requerido

ejemploabcd1234

The external api key for this account

provider

string

Requerido

ejemploviber_service_msg

The provider (will be viber_service_msg).

Ejemplo Respuesta

{
   "name": "optionalName",
   "applications": [
      "78d335fa-323d-0114-9c3d-d6f0d48968cf"
   ],
   "external_id": "12345678",
   "api_key": "abcd1234",
   "provider": "viber_service_msg"
}

Managing your Whatsapp account

Operaciones disponibles

Retrieve a Whatsapp account

Retrieve a Whatsapp account

gethttps://api.nexmo.com/beta/chatapp-accounts/whatsapp/:external_id

Autenticación

Esta API admite tanto la autenticación JWT como la básica. La autenticación básica es más fácil para empezar, pero no admite funciones avanzadas como ACL.

Puede utilizar o bien la autenticación JWT o Basic, pero no ambas a la vez.

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

external_id

string

Requerido

External id of the account you want to retrieve. In this case it will be the WhatsApp number.

Respuestas
Tipo de contenido
application/json

OK.

name

string

ejemplooptionalName

The account name

applications

array

The array of associated application ids

external_id

string

Requerido

ejemplo12345678

The external identifier for this account

api_key

string

Requerido

ejemploabcd1234

The external api key for this account

provider

string

Requerido

ejemplowhatsapp

The provider (will be whatsapp).

Ejemplo Respuesta

{
   "name": "optionalName",
   "applications": [
      "optionalApplicationId"
   ],
   "external_id": "12345678",
   "api_key": "abcd1234",
   "provider": "whatsapp"
}

External Accounts API

Application

Operaciones disponibles

Link application to an account

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Unlink application from an account

Autenticación

Ruta Parámetros

Respuestas

Account

Operaciones disponibles

Retrieve all accounts you own

Autenticación

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Facebook Messenger

Operaciones disponibles

Create a Messenger account

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Retrieve a Messenger account

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Update a Messenger account

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Delete a Messenger account

Autenticación

Ruta Parámetros

Respuestas

Viber Service Message

Operaciones disponibles

Retrieve a Viber Service Message account

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Whatsapp

Operaciones disponibles

Retrieve a Whatsapp account

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json