Operações disponíveis
Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
Caminho Parâmetros
Provider of the account you want to assign an application to
messengerviber_service_msgwhatsapprcsExternal 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.
78d335fa-323d-0114-9c3d-d6f0d48968cfThere is just one application allowed per an account. The application type must be type "messages". For more information please see Application API Spec
Exemplo Solicitação
{
"application": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
}nameThe account name
The array of associated application ids
12345678The external identifier for this account
abcd1234The external api key for this account
messengerThe provider (will be one of messenger, viber_service_msg, whatsapp, rcs).
messengerviber_service_msgwhatsapprcsaccessTokenThe provider access token (only for messenger)
Exemplo Resposta
{
"name": "name",
"applications": [
"78d335fa-323d-0114-9c3d-d6f0d48968cf"
],
"external_id": "12345678",
"api_key": "abcd1234",
"provider": "messenger",
"access_token": "accessToken"
}Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
Caminho Parâmetros
Provider of the account you want to unlink an application from
messengerviber_service_msgwhatsapprcsExternal id of the account you want to unlink an application from
Id of the application you want to unlink
Operações disponíveis
Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
110optionalNameThe account name
The array of associated application ids
12345678The external identifier for this account
abcd1234The external api key for this account
[
"messenger",
"viber_service_msg",
"whatsapp"
]The provider (will be messenger).
myAccessTokenThe provider access token
https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10https://api.nexmo.com/beta/chatapp-accounts?page_number=3&page_size=10https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10https://api.nexmo.com/beta/chatapp-accounts?page_number=1&page_size=10https://api.nexmo.com/beta/chatapp-accounts?page_number=4&page_size=10Exemplo Resposta
{
"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
Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
12345678This 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.
myAccessTokenThis 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
optionalNameCustom account name
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".
Exemplo Solicitação
{
"external_id": "12345678",
"access_token": "myAccessToken",
"name": "optionalName",
"applications": [
"78d335fa-323d-0114-9c3d-d6f0d48968cf"
]
}optionalNameThe account name
The array of associated application ids
12345678The external identifier for this account
abcd1234The external api key for this account
messengerThe provider (will be messenger).
myAccessTokenThe provider access token
Exemplo Resposta
{
"name": "optionalName",
"applications": [
"78d335fa-323d-0114-9c3d-d6f0d48968cf"
],
"external_id": "12345678",
"api_key": "abcd1234",
"provider": "messenger",
"access_token": "myAccessToken"
}Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
optionalNameThe account name
The array of associated application ids
12345678The external identifier for this account
abcd1234The external api key for this account
messengerThe provider (will be messenger).
myAccessTokenThe provider access token
Exemplo Resposta
{
"name": "optionalName",
"applications": [
"78d335fa-323d-0114-9c3d-d6f0d48968cf"
],
"external_id": "12345678",
"api_key": "abcd1234",
"provider": "messenger",
"access_token": "myAccessToken"
}Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
newNameThe new account name
updatedAccessTokenExemplo Solicitação
{
"name": "newName",
"applications": [
"78d335fa-323d-0114-9c3d-d6f0d48968cf"
],
"access_token": "updatedAccessToken"
}newNameThe account name
The array of associated application ids
12345678The external identifier for this account. In this case it is the Facebook Page ID.
abcd1234The external api key for this account
messengerThe provider (will be messenger).
updatedAccessTokenThe provider access token
Exemplo Resposta
{
"name": "newName",
"applications": [
"78d335fa-323d-0114-9c3d-d6f0d48968cf"
],
"external_id": "12345678",
"api_key": "abcd1234",
"provider": "messenger",
"access_token": "updatedAccessToken"
}Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
Viber Service Message
Managing your Viber Service Message account
Operações disponíveis
Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
optionalNameThe account name
The array of associated application ids
12345678The external identifier for this account
abcd1234The external api key for this account
viber_service_msgThe provider (will be viber_service_msg).
Exemplo Resposta
{
"name": "optionalName",
"applications": [
"78d335fa-323d-0114-9c3d-d6f0d48968cf"
],
"external_id": "12345678",
"api_key": "abcd1234",
"provider": "viber_service_msg"
}Managing your Whatsapp account
Operações disponíveis
Autenticação
Esta API oferece suporte tanto à autenticação JWT quanto à autenticação básica. A autenticação básica é mais fácil de começar a usar, mas não oferece suporte a recursos avançados, como ACLs.
Você pode usar ou a autenticação JWT ou a autenticação básica, mas não ambas ao mesmo tempo.
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
optionalNameThe account name
The array of associated application ids
12345678The external identifier for this account
abcd1234The external api key for this account
whatsappThe provider (will be whatsapp).
Exemplo Resposta
{
"name": "optionalName",
"applications": [
"optionalApplicationId"
],
"external_id": "12345678",
"api_key": "abcd1234",
"provider": "whatsapp"
}