Channel Manager API
The Channel Manager API provides a way of managing configuration and data related to various messaging channels in the Vonage Messages API. Find out more at https://developer.vonage.com/en/api/channel-manager.
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> |
11020The size of the page
111The current page
142Total number of pages
871The total number of items in the resource list
345688589250625The ID of the WhatsApp Business Account.
abc123The API key of the Vonage account associated with the WhatsApp Business Account.
My BusinessThe name of the WhatsApp Business Account.
ApprovedThe review status of the WhatsApp Business Account.
PendingApprovedRejected58The ID of the timezone of the WhatsApp Business Account.
USDThe currency of the WhatsApp Business Account.
1234567890The ID of the solution of the WhatsApp Business Account. Applies for WABAs onboarded through a partner solution
USThe country of the WhatsApp Business Account's owning Meta Business account.
224654643345ID of the business manager or portfolio that contains the WhatsApp Business Account
Vonage Communication APIs & Conversational Commerce PlatformName of the business manager or portfolio that contains the WhatsApp Business Account
ACTIVEACTIVEWhatsApp Business Account status
ACTIVEINELIGIBLENOT_STARTEDINELIGBLE_ON_BEHALF_OF_WABAPENDINGDELETEDMIGRATEDBANNEDRESTRICTEDRATE_LIMITEDFLAGGEDCONNECTEDDISCONNECTEDUNKNOWNUNVERIFIEDOFFLINETIER_10KMaximum number of unique WhatsApp user phone numbers that your Business Manager account can message, outside of a customer service window, within a moving 24-hour period. This limit is shared across all WhatsApp phone numbers owned by your business.
For more information on messaging limits see the Meta documentation.
TIER_100KTIER_10KTIER_250TIER_2KTIER_UNLIMITEDUNTIEREDELIGIBLEOnboarding status of the WhatsApp Business account into Marketing Messages API.
INELIGIBLE_ON_BEHALF_OF_WABAINELIGIBLE_INACTIVE_OR_RESTRICTEDINELIGIBLE_COUNTRY_NOT_SUPPORTEDINELIGIBLE_USING_WHATSAPP_BUSINESS_APPELIGIBLEPENDING_VALID_PAYMENT_METHODPENDING_INTERNAL_SETUPONBOARDEDHAL links for page-based paginated collections
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Exemplo Resposta
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> |
345688589250625The ID of the WhatsApp Business Account.
abc123The API key of the Vonage account associated with the WhatsApp Business Account.
My BusinessThe name of the WhatsApp Business Account.
ApprovedThe review status of the WhatsApp Business Account.
PendingApprovedRejected58The ID of the timezone of the WhatsApp Business Account.
USDThe currency of the WhatsApp Business Account.
1234567890The ID of the solution of the WhatsApp Business Account. Applies for WABAs onboarded through a partner solution
USThe country of the WhatsApp Business Account's owning Meta Business account.
224654643345ID of the business manager or portfolio that contains the WhatsApp Business Account
Vonage Communication APIs & Conversational Commerce PlatformName of the business manager or portfolio that contains the WhatsApp Business Account
ACTIVEACTIVEWhatsApp Business Account status
ACTIVEINELIGIBLENOT_STARTEDINELIGBLE_ON_BEHALF_OF_WABAPENDINGDELETEDMIGRATEDBANNEDRESTRICTEDRATE_LIMITEDFLAGGEDCONNECTEDDISCONNECTEDUNKNOWNUNVERIFIEDOFFLINETIER_10KMaximum number of unique WhatsApp user phone numbers that your Business Manager account can message, outside of a customer service window, within a moving 24-hour period. This limit is shared across all WhatsApp phone numbers owned by your business.
For more information on messaging limits see the Meta documentation.
TIER_100KTIER_10KTIER_250TIER_2KTIER_UNLIMITEDUNTIEREDELIGIBLEOnboarding status of the WhatsApp Business account into Marketing Messages API.
INELIGIBLE_ON_BEHALF_OF_WABAINELIGIBLE_INACTIVE_OR_RESTRICTEDINELIGIBLE_COUNTRY_NOT_SUPPORTEDINELIGIBLE_USING_WHATSAPP_BUSINESS_APPELIGIBLEPENDING_VALID_PAYMENT_METHODPENDING_INTERNAL_SETUPONBOARDEDLink to the current resource (always required in HAL)
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Exemplo Resposta
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> |
11020The size of the page
111The current page
142Total number of pages
871The total number of items in the resource list
447451277751The phone number associated with the WhatsApp Business Account.
293464193855848The ID of the phone number associated with the WhatsApp Business Account.
345688589250625The ID of the WhatsApp Business Account.
abc123The API key of the Vonage account associated with the WhatsApp Business Account.
My BusinessThe WhatsApp display name for number
VERIFIEDIndicates the phone number's one-time password (OTP) verification status.
- Only phone numbers with a
VERIFIEDstatus can be registered. - An
EXPIREDstatus means that the phone number was previously verified but the 14 day verification period has ended. If the phone number is not registered, it will need to be verified again.
NOT_VERIFIEDVERIFIEDEXPIRED+447451277751How the number is displayed on WhatsApp accounts.
TIER_100KThe messaging limit tier of the phone number. See WhatsApp messaging limits
TIER_50TIER_250TIER_1KTIER_10KTIER_100KTIER_UNLIMITEDThe quality score of the phone number. See WhatsApp Business phone number’s quality rating
GREENThe quality score of the phone number.
- GREEN: High quality
- YELLOW: Medium quality
- RED: Low quality
GREENYELLOWREDThe throughput level of the phone number. Indication of throughput permissible by WhatsApp e.g. STANDARD is the default 80 messages/sec
STANDARDThe throughput rate of the phone number.
HAL links for page-based paginated collections
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Exemplo Resposta
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> |
447451277751The phone number associated with the WhatsApp Business Account.
293464193855848The ID of the phone number associated with the WhatsApp Business Account.
345688589250625The ID of the WhatsApp Business Account.
abc123The API key of the Vonage account associated with the WhatsApp Business Account.
My BusinessThe WhatsApp display name for number
VERIFIEDIndicates the phone number's one-time password (OTP) verification status.
- Only phone numbers with a
VERIFIEDstatus can be registered. - An
EXPIREDstatus means that the phone number was previously verified but the 14 day verification period has ended. If the phone number is not registered, it will need to be verified again.
NOT_VERIFIEDVERIFIEDEXPIRED+447451277751How the number is displayed on WhatsApp accounts.
TIER_100KThe messaging limit tier of the phone number. See WhatsApp messaging limits
TIER_50TIER_250TIER_1KTIER_10KTIER_100KTIER_UNLIMITEDThe quality score of the phone number. See WhatsApp Business phone number’s quality rating
GREENThe quality score of the phone number.
- GREEN: High quality
- YELLOW: Medium quality
- RED: Low quality
GREENYELLOWREDThe throughput level of the phone number. Indication of throughput permissible by WhatsApp e.g. STANDARD is the default 80 messages/sec
STANDARDThe throughput rate of the phone number.
Link to the current resource (always required in HAL)
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Exemplo Resposta
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> |
About my businessInformation about the profile
123 Main Street, Anytown, USAThe address of the profile
Description of my businessThe description of the profile
bob@example.comThe email address of the profile
https://example.com/profile.pngURL of picture for the profile. Profile picture must be a square JPG or PNG, with min dimensions of 192px x 192px, and max dimensions of 640 px x 640 px, and a max file size of 800 kb. If the image is larger, it will get automatically centre-cropped to fit these dimensions
URLs of websites for the profile
OTHERThe Industry or Business Category of the WhatsApp Profile
APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVELwhatsappThe messaging product with which the profile is associated.
whatsappLink to the current resource (always required in HAL)
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Exemplo Resposta
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> |
About my businessInformation about the profile
123 Main Street, Anytown, USAThe address of the profile
Description of my businessThe description of the profile
bob@example.comThe email address of the profile
https://example.com/profile.pngURL of picture for the profile. Profile picture must be a square JPG or PNG, with min dimensions of 192px x 192px, and max dimensions of 640 px x 640 px, and a max file size of 800 kb. If the image is larger, it will get automatically centre-cropped to fit these dimensions
URLs of websites for the profile
OTHERThe Industry or Business Category of the WhatsApp Profile
APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVELExemplo Solicitação
{
"about": "About my business",
"address": "123 Main Street, Anytown, USA",
"description": "Description of my business",
"email": "bob@example.com",
"profile_picture_url": "https://example.com/profile.png",
"websites": [
"https://example.com",
"https://example.org"
],
"vertical": "OTHER"
}About my businessInformation about the profile
123 Main Street, Anytown, USAThe address of the profile
Description of my businessThe description of the profile
bob@example.comThe email address of the profile
https://example.com/profile.pngURL of picture for the profile. Profile picture must be a square JPG or PNG, with min dimensions of 192px x 192px, and max dimensions of 640 px x 640 px, and a max file size of 800 kb. If the image is larger, it will get automatically centre-cropped to fit these dimensions
URLs of websites for the profile
OTHERThe Industry or Business Category of the WhatsApp Profile
APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVELwhatsappThe messaging product with which the profile is associated.
whatsappLink to the current resource (always required in HAL)
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Exemplo Resposta
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> |
123456789111213The partner solution ID.
abc123The API key of the Vonage account associated with the WhatsApp Business Account.
25920086400300The time-to-live for the URL in seconds.
Exemplo Solicitação
3amb0119-0196-42d1-8fb5-55a98s133546The trace ID for the URL generation request.
https://tools.vonage.com/wa/partners/onboard?token=fhdhhdJhbGciOiJSUzI1NiJ9.eyJleHAiOjE3MjU5Njc1OTYsImp0aSI6ImQ1MmJhNmFjLWYxZjktNDdmNC05MTR_cFT1bVfkDhP-wgpKZibSbUoh9z-9KGD-wsmHxi0h7tTidpVhPNShfC5jmgiHtOQKXXv5NWb9OqoUraOMMpqCdNdXoN3ao-PeZX7axyYW_FQ6CeV9gDEPhAZ4urTi0uW4mCYGl3ULmA9Ps92r_wi2DJyRE_Kx2KahWtQd51yVpU6FfXgMb4odREEccDctT1Peo09wKgwBa1wsOkD7rrvkoQPqZ00VXcqOY1_LOO5tq4WJaKqtxX-U7VtDo9qyVUl8pdegZW6QWChQzGN4PkqXXLWcBlyrCtAYdhtWG8q6NM_6bARRjcGJlj0tQvE0PZ9AtafAQSPpOll5lcnUK8DsURL containing tokenized information and redirecting to ES flow start page.
Exemplo Resposta
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> |
Consulta Parâmetros
An array of the template_ids of the WhatsApp template(s).
2024-11-01The start date and time in ISO-8601 format for the analytics data to be retrieved from, in the format YYYY-MM-DD.
2024-11-03The end date and time in ISO-8601 format for the analytics data to be retrieved to, in the format YYYY-MM-DD. The maximum difference between the start and end dates is 90 days.
[
"SENT",
"DELIVERED"
]An array of the metric types to retrieve analytics for. Possible values are SENT, DELIVERED, READ, and CLICKED.
SENT,DELIVERED,READ,CLICKEDDAILYThe granularity at which you would like to retrieve the template analytics.
DAILYDAILYDAILYCLOUD_APIThe product type for which the template analytics were retrieved.
CLOUD_APIMARKETING_MESSAGES_API_FOR_WHATSAPP100The maximum number of template analytics returned per page.
458951126288942The ID of the WhatsApp Template which the analytics data is for.
1543543200The UNIX timestamp for the start of the data point range.
1543629600The UNIX timestamp for the end of the data point range.
100The number of messages sent using the WhatsApp Template.
90The number of messages delivered using the WhatsApp Template.
80The number of messages read using the WhatsApp Template.
70The number of messages clicked using the WhatsApp Template.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/template-analytics?template_ids=[458951126288937]&start=2024-11-10&end=2024-11-14&page_size=100&cursor=c2VsZj1udWxsThe URL to the current page of WhatsApp Template Analytics.
Exemplo Resposta
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> |
Consulta Parâmetros
DAILYThe granularity at which you would like to retrieve the analytics.
HALF_HOURDAILYMONTHLY2024-11-01The start date and time in ISO-8601 format for the analytics data to be retrieved from, in the format YYYY-MM-DD.
2024-11-03The end date and time in ISO-8601 format for the analytics data to be retrieved to, in the format YYYY-MM-DD. The maximum difference between the start and end dates is 90 days.
[
0
]An array of the message types to retrieve analytics for. Possible values are 0 for notification messages and/or 2 for customer support messages. If not specified, analytics for all message types will be returned.
0,2[
"16505550111"
]Phone numbers for which you would like to retrieve analytics. If not specified, analytics for all phone numbers associated with the WABA will be returned.
[
"US"
]Two-letter country codes for the countries for which you would like to retrieve analytics. If not specified, analytics for all countries will be returned.
345688589250625The ID of the WhatsApp Business Account.
DAILYHALF_HOURDAILYMONTHLYPhone numbers for which the messaging analytics were retrieved.
1543543200The UNIX timestamp for the start of the data point range.
1543629600The UNIX timestamp for the end of the data point range.
100The number of messages sent using the WhatsApp Template.
90The number of messages delivered within the data point range.
MAZDZDThe page before the first page in the current list
MjQZDThe page after the last page in the current list
https://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?after=MAZDZDA URI to ge the next paginated page.
https://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?before=MjQZDA URI to ge the previous paginated page.
Exemplo Resposta
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> |
Consulta Parâmetros
2024-11-01The start date and time in ISO-8601 format for the analytics data to be retrieved from, in the format YYYY-MM-DD.
2024-11-03The end date and time in ISO-8601 format for the analytics data to be retrieved to, in the format YYYY-MM-DD. The maximum difference between the start and end dates is 90 days.
DAILYThe granularity at which you would like to retrieve the analytics.
HALF_HOURDAILYMONTHLY[
"16505550111"
]Phone numbers for which you would like to retrieve analytics. If not specified, analytics for all phone numbers associated with the WABA will be returned.
[
"US"
]Two-letter country codes for the countries for which you would like to retrieve analytics. If not specified, analytics for all countries will be returned.
[
"PRICING_CATEGORY"
]List of breakdowns you would like to apply to your metrics. If empty, all results returned without any breakdowns.
PRICING_CATEGORY,PRICING_TYPE,COUNTRY,PHONE,TIER[
"0:100000"
]The tier property value represents a concatenation of the lower and upper bounds for the tier specific to the market–category pair (country and pricing_category).
DAILYHALF_HOURDAILYMONTHLYREGULARThe product type for which the pricing analytics were retrieved.
FREE_CUSTOMER_SERVICEFREE_ENTRY_POINTREGULAR1543543200The UNIX timestamp for the start of the data point range.
1543629600The UNIX timestamp for the end of the data point range.
100The number of messages sent.
14155552671The phone number associated with the Messaging Analytics.
USThe country for the phone number associated with the Messaging Analytics.
75000:150000The pricing tier for the messages related to the Messaging Analytics.
REGULARThe pricing type for the messages related to the Messaging Analytics.
AUTHENTICATIONThe pricing category for the messages related to the Messaging Analytics.
MjQZDThe cursor the previous page of WhatsApp Pricing Analytics.
MAZDZDThe cursor the next page of WhatsApp Pricing Analytics.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MjQZDThe URL to the previous page of WhatsApp Pricing Analytics.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MAZDZDThe URL to the next page of WhatsApp Pricing Analytics.
Exemplo Resposta
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> |
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> |
My WhatsApp SubscriptionAn optional label for the subscription
account_alerts,account_updateA comma-separated list of the WhatsApp notification types that the subscription is for. Supports all the notification types available for WhatsApp accounts listed here. When a new subscription is created, if this parameter is not specified then the subscription will include all of the subscription types.
vonage_number_onboardedA comma-separated list of the Vonage notification types that the subscription is for.
vonage_number_onboarded2024-11-01T12:00:00ZThe date and time when the subscription was created, in ISO-8601 format.
9fa85698-c92a-4786-be0e-b5a489425120The unique ID of the subscription
slackThe subscription type
slackThe Slack hook configuration for the subscription, where the subscription type is slack.
https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXXThe URL of the Slack hook to which the WhatsApp notifications will be sent
Exemplo Resposta
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> |
My WhatsApp SubscriptionAn optional label for the subscription
account_alerts,account_updateA comma-separated list of the WhatsApp notification types that the subscription is for. Supports all the notification types available for WhatsApp accounts listed here. When a new subscription is created, if this parameter is not specified then the subscription will include all of the subscription types.
vonage_number_onboardedA comma-separated list of the Vonage notification types that the subscription is for.
vonage_number_onboarded2024-11-01T12:00:00ZThe date and time when the subscription was created, in ISO-8601 format.
9fa85698-c92a-4786-be0e-b5a489425120The unique ID of the subscription
slackThe subscription type
slackThe Slack hook configuration for the subscription, where the subscription type is slack.
https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXXThe URL of the Slack hook to which the WhatsApp notifications will be sent
Exemplo Solicitação
My WhatsApp SubscriptionAn optional label for the subscription
account_alerts,account_updateA comma-separated list of the WhatsApp notification types that the subscription is for. Supports all the notification types available for WhatsApp accounts listed here. When a new subscription is created, if this parameter is not specified then the subscription will include all of the subscription types.
vonage_number_onboardedA comma-separated list of the Vonage notification types that the subscription is for.
vonage_number_onboarded2024-11-01T12:00:00ZThe date and time when the subscription was created, in ISO-8601 format.
9fa85698-c92a-4786-be0e-b5a489425120The unique ID of the subscription
slackThe subscription type
slackThe Slack hook configuration for the subscription, where the subscription type is slack.
https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXXThe URL of the Slack hook to which the WhatsApp notifications will be sent
Exemplo Resposta
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> |
RCS Capabilities Device Check
Get RCS Capabilities for a Specific Device. Please note that this operation is deprecated, please refer to this one instead.
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
A list of RCS capabilities for the device being checked.
RICHCARD_STANDALONE,RICHCARD_CAROUSEL,ACTION_CREATE_CALENDAR_EVENT,ACTION_DIAL,ACTION_OPEN_URL,ACTION_SHARE_LOCATION,ACTION_VIEW_LOCATIONExemplo Resposta
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> |
447700900001E.164 formatted phone number without + prefix
GBThe country code of the device to check.
Exemplo Solicitação
trueIndicates if RCS is supported on the device.
A list of RCS capabilities for the device being checked.
RICHCARD_STANDALONE,RICHCARD_CAROUSEL,ACTION_CREATE_CALENDAR_EVENT,ACTION_DIAL,ACTION_OPEN_URL,ACTION_SHARE_LOCATION,ACTION_VIEW_LOCATIONExemplo Resposta
RCS Capabilities Bulk Check
Perform an RCS Capability Check for Multiple Devices. See the RCS Capability Checks documentation for more information.
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Seu token JSON da Web. | Headers | Bearer <JWT> |
An array of phone numbers to check.
Exemplo Solicitação
A list of specific numbers for devices that reachable for RCS messaging.
Exemplo Resposta»Response where 500 numbers or less submitted.
Operações disponíveis
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
trueIndicates if opt-out is enabled for the user.
A list of actions available for opt-out.
A list of keywords that trigger the action.
You have opted out.The auto-reply message sent when the action is triggered.
STOPThe type of action.
STOPSTARTCUSTOMExemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
trueIndicates if opt-out is enabled for the user.
A list of actions available for opt-out.
A list of keywords that trigger the action.
You have opted out.The auto-reply message sent when the action is triggered.
STOPThe type of action.
STOPSTARTCUSTOMExemplo Solicitação
trueIndicates if opt-out is enabled for the user.
A list of actions available for opt-out.
A list of keywords that trigger the action.
You have opted out.The auto-reply message sent when the action is triggered.
STOPThe type of action.
STOPSTARTCUSTOMExemplo Resposta
Operações disponíveis
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
My RCS BrandThe name of the RCS Brand.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
My RCS BrandThe name of the RCS Brand.
Exemplo Solicitação
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
My RCS BrandThe name of the RCS Brand.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
My RCS BrandThe name of the RCS Brand.
Exemplo Solicitação
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
My RCS BrandThe name of the RCS Brand.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
Consulta Parâmetros
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of an RCS Brand to filter by.
DRAFTThe state of the RCS Agent to filter by.
DRAFTCREATEDVERIFIEDLAUNCHEDREJECTEDUNLAUNCHEDTRANSACTIONALThe agent_purpose of the RCS Agent to filter by.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALThe billing_category of the RCS Agent to filter by.
CONVERSATIONALNON_CONVERSATIONALNORTH_AMERICAThe hosting_region of the RCS Agent to filter by.
NORTH_AMERICAEUROPEASIA_PACIFIC111Page number to retrieve
11020Number of items to return per page
The order.
ascdesc111The current page
11020The size of the page
871The total number of items in the resource list
142Total number of pages
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
Example CoThe unique display name of the RCS Agent.
ExampleCo-RCSAgent-1A unique sender identifier on the Vonage platform. This cannot be blank, include whitespaces, or be changed after creation.
The sender ID is used as the from value when sending RCS messages via the Messages API.
NORTH_AMERICAThe geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.
NORTH_AMERICAEUROPEASIA_PACIFICTRANSACTIONALSpecifies the intended use of the RCS Agent. This cannot be changed after creation.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALSpecifies the billing category of the RCS Agent.
CONVERSATIONALNON_CONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.
Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers.
If you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com.
Test the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.
Agent access instructions specify how reviewers and testers can access and interact with your RBM agent during the review and testing phases before launch. This property provides guidance on methods for triggering agent functionality and testing various features.
imageThe media type of the agent preview.
imagevideohttps://www.example.com/rcs-agent-preview.jpgThe URL to the agent preview.
A list of points of contact for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
200Technical SupportThe job title of the point of contact.
Traffic estimates for the RCS Agent.
THOUSANDEstimated global traffic.
THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MOREONCE_PER_MONTHEstimated message rate per user.
ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAYHUNDREDEstimated number of users targeted.
HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE10000This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses.
Secondary interactions may include promotional offers for existing customers and appointment scheduling assistance.
This field describes the primary and secondary types of interactions your RBM agent will have with users. It outlines the conversational patterns, message types, and engagement scenarios your agent supports.
10000This is a test environment. Customers consent to receive messages directly via request, phone, or email.
Users can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode.
Opt-in confirmation includes details about message frequency and content type.
Details how users will provide consent to receive messages from your RBM agent. This must clearly explain the opt-in mechanism and what users can expect when they subscribe to your messaging service.
10000Customers can unsubscribe from receiving messages by replying 'STOP' to any message.
They can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed,
and can re-subscribe at any time by replying 'START'.
Explains how users can unsubscribe from receiving messages from your agent. Must describe the process for users to stop receiving communications and how your system handles these requests.
10000This account is used exclusively for sending test messages to introduce RCS capabilities to customers.
Triggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations,
and weekly promotional campaigns for opted-in users.
Defines the external events or conditions that will cause your RBM agent to initiate conversations with users. These triggers determine when and why your agent sends the first message to users.
#8860CDThe hexadecimal color code for the primary color used in UI elements. The specified color must meet WCAG 2.1 contrast ratio of 4.5:1 for legibility.
support@example.comThe contact email address for the RCS Agent.
25Customer SupportA label for the email address.
447700900001E.164 formatted phone number without + prefix
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
https://example.com25Company WebsiteA label for the website URL.
https://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkzA publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.
https://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqbA publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.
https://www.example.com/privacy-policyThe publicly accessible URL of the privacy policy for the RCS Agent.
https://www.example.com/terms-of-serviceThe publicly accessible URL of the terms of service for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was created.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was last updated.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the test device.
447700900001E.164 formatted phone number without + prefix
ACCEPTEDThe current status of the test device.
2023-01-01T12:00:00ZThe date and time when the test device was created.
att-usThe id of the carrier.
LAUNCH_STATE_UNLAUNCHEDThe launch state of the carrier.
LAUNCH_STATE_UNSPECIFIEDLAUNCH_STATE_UNLAUNCHEDLAUNCH_STATE_PENDINGLAUNCH_STATE_LAUNCHEDLAUNCH_STATE_REJECTEDLAUNCH_STATE_SUSPENDEDLAUNCH_STATE_PENDING_UNLAUNCHLAUNCH_STATE_INVALID_IN_GMBVERIFICATION_STATE_UNVERIFIEDThe verification status of the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent launch was submitted.
HAL links for page-based paginated collections
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
Example CoThe unique display name of the RCS Agent.
ExampleCo-RCSAgent-1A unique sender identifier on the Vonage platform. This cannot be blank, include whitespaces, or be changed after creation.
The sender ID is used as the from value when sending RCS messages via the Messages API.
NORTH_AMERICAThe geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.
NORTH_AMERICAEUROPEASIA_PACIFICTRANSACTIONALSpecifies the intended use of the RCS Agent. This cannot be changed after creation.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALSpecifies the billing category of the RCS Agent.
CONVERSATIONALNON_CONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.
Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers.
If you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com.
Test the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.
Agent access instructions specify how reviewers and testers can access and interact with your RBM agent during the review and testing phases before launch. This property provides guidance on methods for triggering agent functionality and testing various features.
imageThe media type of the agent preview.
imagevideohttps://www.example.com/rcs-agent-preview.jpgThe URL to the agent preview.
A list of points of contact for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
200Technical SupportThe job title of the point of contact.
Traffic estimates for the RCS Agent.
THOUSANDEstimated global traffic.
THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MOREONCE_PER_MONTHEstimated message rate per user.
ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAYHUNDREDEstimated number of users targeted.
HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE10000This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses.
Secondary interactions may include promotional offers for existing customers and appointment scheduling assistance.
This field describes the primary and secondary types of interactions your RBM agent will have with users. It outlines the conversational patterns, message types, and engagement scenarios your agent supports.
10000This is a test environment. Customers consent to receive messages directly via request, phone, or email.
Users can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode.
Opt-in confirmation includes details about message frequency and content type.
Details how users will provide consent to receive messages from your RBM agent. This must clearly explain the opt-in mechanism and what users can expect when they subscribe to your messaging service.
10000Customers can unsubscribe from receiving messages by replying 'STOP' to any message.
They can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed,
and can re-subscribe at any time by replying 'START'.
Explains how users can unsubscribe from receiving messages from your agent. Must describe the process for users to stop receiving communications and how your system handles these requests.
10000This account is used exclusively for sending test messages to introduce RCS capabilities to customers.
Triggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations,
and weekly promotional campaigns for opted-in users.
Defines the external events or conditions that will cause your RBM agent to initiate conversations with users. These triggers determine when and why your agent sends the first message to users.
#8860CDThe hexadecimal color code for the primary color used in UI elements. The specified color must meet WCAG 2.1 contrast ratio of 4.5:1 for legibility.
support@example.comThe contact email address for the RCS Agent.
25Customer SupportA label for the email address.
447700900001E.164 formatted phone number without + prefix
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
https://example.com25Company WebsiteA label for the website URL.
https://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkzA publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.
https://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqbA publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.
https://www.example.com/privacy-policyThe publicly accessible URL of the privacy policy for the RCS Agent.
https://www.example.com/terms-of-serviceThe publicly accessible URL of the terms of service for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was created.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was last updated.
Exemplo Solicitação
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
Example CoThe unique display name of the RCS Agent.
ExampleCo-RCSAgent-1A unique sender identifier on the Vonage platform. This cannot be blank, include whitespaces, or be changed after creation.
The sender ID is used as the from value when sending RCS messages via the Messages API.
NORTH_AMERICAThe geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.
NORTH_AMERICAEUROPEASIA_PACIFICTRANSACTIONALSpecifies the intended use of the RCS Agent. This cannot be changed after creation.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALSpecifies the billing category of the RCS Agent.
CONVERSATIONALNON_CONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.
Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers.
If you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com.
Test the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.
Agent access instructions specify how reviewers and testers can access and interact with your RBM agent during the review and testing phases before launch. This property provides guidance on methods for triggering agent functionality and testing various features.
imageThe media type of the agent preview.
imagevideohttps://www.example.com/rcs-agent-preview.jpgThe URL to the agent preview.
A list of points of contact for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
200Technical SupportThe job title of the point of contact.
Traffic estimates for the RCS Agent.
THOUSANDEstimated global traffic.
THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MOREONCE_PER_MONTHEstimated message rate per user.
ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAYHUNDREDEstimated number of users targeted.
HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE10000This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses.
Secondary interactions may include promotional offers for existing customers and appointment scheduling assistance.
This field describes the primary and secondary types of interactions your RBM agent will have with users. It outlines the conversational patterns, message types, and engagement scenarios your agent supports.
10000This is a test environment. Customers consent to receive messages directly via request, phone, or email.
Users can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode.
Opt-in confirmation includes details about message frequency and content type.
Details how users will provide consent to receive messages from your RBM agent. This must clearly explain the opt-in mechanism and what users can expect when they subscribe to your messaging service.
10000Customers can unsubscribe from receiving messages by replying 'STOP' to any message.
They can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed,
and can re-subscribe at any time by replying 'START'.
Explains how users can unsubscribe from receiving messages from your agent. Must describe the process for users to stop receiving communications and how your system handles these requests.
10000This account is used exclusively for sending test messages to introduce RCS capabilities to customers.
Triggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations,
and weekly promotional campaigns for opted-in users.
Defines the external events or conditions that will cause your RBM agent to initiate conversations with users. These triggers determine when and why your agent sends the first message to users.
#8860CDThe hexadecimal color code for the primary color used in UI elements. The specified color must meet WCAG 2.1 contrast ratio of 4.5:1 for legibility.
support@example.comThe contact email address for the RCS Agent.
25Customer SupportA label for the email address.
447700900001E.164 formatted phone number without + prefix
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
https://example.com25Company WebsiteA label for the website URL.
https://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkzA publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.
https://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqbA publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.
https://www.example.com/privacy-policyThe publicly accessible URL of the privacy policy for the RCS Agent.
https://www.example.com/terms-of-serviceThe publicly accessible URL of the terms of service for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was created.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was last updated.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
Example CoThe unique display name of the RCS Agent.
ExampleCo-RCSAgent-1A unique sender identifier on the Vonage platform. This cannot be blank, include whitespaces, or be changed after creation.
The sender ID is used as the from value when sending RCS messages via the Messages API.
NORTH_AMERICAThe geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.
NORTH_AMERICAEUROPEASIA_PACIFICTRANSACTIONALSpecifies the intended use of the RCS Agent. This cannot be changed after creation.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALSpecifies the billing category of the RCS Agent.
CONVERSATIONALNON_CONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.
Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers.
If you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com.
Test the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.
Agent access instructions specify how reviewers and testers can access and interact with your RBM agent during the review and testing phases before launch. This property provides guidance on methods for triggering agent functionality and testing various features.
imageThe media type of the agent preview.
imagevideohttps://www.example.com/rcs-agent-preview.jpgThe URL to the agent preview.
A list of points of contact for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
200Technical SupportThe job title of the point of contact.
Traffic estimates for the RCS Agent.
THOUSANDEstimated global traffic.
THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MOREONCE_PER_MONTHEstimated message rate per user.
ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAYHUNDREDEstimated number of users targeted.
HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE10000This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses.
Secondary interactions may include promotional offers for existing customers and appointment scheduling assistance.
This field describes the primary and secondary types of interactions your RBM agent will have with users. It outlines the conversational patterns, message types, and engagement scenarios your agent supports.
10000This is a test environment. Customers consent to receive messages directly via request, phone, or email.
Users can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode.
Opt-in confirmation includes details about message frequency and content type.
Details how users will provide consent to receive messages from your RBM agent. This must clearly explain the opt-in mechanism and what users can expect when they subscribe to your messaging service.
10000Customers can unsubscribe from receiving messages by replying 'STOP' to any message.
They can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed,
and can re-subscribe at any time by replying 'START'.
Explains how users can unsubscribe from receiving messages from your agent. Must describe the process for users to stop receiving communications and how your system handles these requests.
10000This account is used exclusively for sending test messages to introduce RCS capabilities to customers.
Triggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations,
and weekly promotional campaigns for opted-in users.
Defines the external events or conditions that will cause your RBM agent to initiate conversations with users. These triggers determine when and why your agent sends the first message to users.
#8860CDThe hexadecimal color code for the primary color used in UI elements. The specified color must meet WCAG 2.1 contrast ratio of 4.5:1 for legibility.
support@example.comThe contact email address for the RCS Agent.
25Customer SupportA label for the email address.
447700900001E.164 formatted phone number without + prefix
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
https://example.com25Company WebsiteA label for the website URL.
https://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkzA publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.
https://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqbA publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.
https://www.example.com/privacy-policyThe publicly accessible URL of the privacy policy for the RCS Agent.
https://www.example.com/terms-of-serviceThe publicly accessible URL of the terms of service for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was created.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was last updated.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the test device.
447700900001E.164 formatted phone number without + prefix
ACCEPTEDThe current status of the test device.
2023-01-01T12:00:00ZThe date and time when the test device was created.
att-usThe id of the carrier.
LAUNCH_STATE_UNLAUNCHEDThe launch state of the carrier.
LAUNCH_STATE_UNSPECIFIEDLAUNCH_STATE_UNLAUNCHEDLAUNCH_STATE_PENDINGLAUNCH_STATE_LAUNCHEDLAUNCH_STATE_REJECTEDLAUNCH_STATE_SUSPENDEDLAUNCH_STATE_PENDING_UNLAUNCHLAUNCH_STATE_INVALID_IN_GMBVERIFICATION_STATE_UNVERIFIEDThe verification status of the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent launch was submitted.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
Example CoThe unique display name of the RCS Agent.
ExampleCo-RCSAgent-1A unique sender identifier on the Vonage platform. This cannot be blank, include whitespaces, or be changed after creation.
The sender ID is used as the from value when sending RCS messages via the Messages API.
NORTH_AMERICAThe geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.
NORTH_AMERICAEUROPEASIA_PACIFICTRANSACTIONALSpecifies the intended use of the RCS Agent. This cannot be changed after creation.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALSpecifies the billing category of the RCS Agent.
CONVERSATIONALNON_CONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.
Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers.
If you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com.
Test the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.
Agent access instructions specify how reviewers and testers can access and interact with your RBM agent during the review and testing phases before launch. This property provides guidance on methods for triggering agent functionality and testing various features.
imageThe media type of the agent preview.
imagevideohttps://www.example.com/rcs-agent-preview.jpgThe URL to the agent preview.
A list of points of contact for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
200Technical SupportThe job title of the point of contact.
Traffic estimates for the RCS Agent.
THOUSANDEstimated global traffic.
THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MOREONCE_PER_MONTHEstimated message rate per user.
ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAYHUNDREDEstimated number of users targeted.
HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE10000This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses.
Secondary interactions may include promotional offers for existing customers and appointment scheduling assistance.
This field describes the primary and secondary types of interactions your RBM agent will have with users. It outlines the conversational patterns, message types, and engagement scenarios your agent supports.
10000This is a test environment. Customers consent to receive messages directly via request, phone, or email.
Users can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode.
Opt-in confirmation includes details about message frequency and content type.
Details how users will provide consent to receive messages from your RBM agent. This must clearly explain the opt-in mechanism and what users can expect when they subscribe to your messaging service.
10000Customers can unsubscribe from receiving messages by replying 'STOP' to any message.
They can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed,
and can re-subscribe at any time by replying 'START'.
Explains how users can unsubscribe from receiving messages from your agent. Must describe the process for users to stop receiving communications and how your system handles these requests.
10000This account is used exclusively for sending test messages to introduce RCS capabilities to customers.
Triggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations,
and weekly promotional campaigns for opted-in users.
Defines the external events or conditions that will cause your RBM agent to initiate conversations with users. These triggers determine when and why your agent sends the first message to users.
#8860CDThe hexadecimal color code for the primary color used in UI elements. The specified color must meet WCAG 2.1 contrast ratio of 4.5:1 for legibility.
support@example.comThe contact email address for the RCS Agent.
25Customer SupportA label for the email address.
447700900001E.164 formatted phone number without + prefix
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
https://example.com25Company WebsiteA label for the website URL.
https://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkzA publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.
https://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqbA publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.
https://www.example.com/privacy-policyThe publicly accessible URL of the privacy policy for the RCS Agent.
https://www.example.com/terms-of-serviceThe publicly accessible URL of the terms of service for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was created.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was last updated.
Exemplo Solicitação
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
Example CoThe unique display name of the RCS Agent.
ExampleCo-RCSAgent-1A unique sender identifier on the Vonage platform. This cannot be blank, include whitespaces, or be changed after creation.
The sender ID is used as the from value when sending RCS messages via the Messages API.
NORTH_AMERICAThe geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.
NORTH_AMERICAEUROPEASIA_PACIFICTRANSACTIONALSpecifies the intended use of the RCS Agent. This cannot be changed after creation.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALSpecifies the billing category of the RCS Agent.
CONVERSATIONALNON_CONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.
Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers.
If you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com.
Test the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.
Agent access instructions specify how reviewers and testers can access and interact with your RBM agent during the review and testing phases before launch. This property provides guidance on methods for triggering agent functionality and testing various features.
imageThe media type of the agent preview.
imagevideohttps://www.example.com/rcs-agent-preview.jpgThe URL to the agent preview.
A list of points of contact for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
200Technical SupportThe job title of the point of contact.
Traffic estimates for the RCS Agent.
THOUSANDEstimated global traffic.
THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MOREONCE_PER_MONTHEstimated message rate per user.
ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAYHUNDREDEstimated number of users targeted.
HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE10000This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses.
Secondary interactions may include promotional offers for existing customers and appointment scheduling assistance.
This field describes the primary and secondary types of interactions your RBM agent will have with users. It outlines the conversational patterns, message types, and engagement scenarios your agent supports.
10000This is a test environment. Customers consent to receive messages directly via request, phone, or email.
Users can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode.
Opt-in confirmation includes details about message frequency and content type.
Details how users will provide consent to receive messages from your RBM agent. This must clearly explain the opt-in mechanism and what users can expect when they subscribe to your messaging service.
10000Customers can unsubscribe from receiving messages by replying 'STOP' to any message.
They can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed,
and can re-subscribe at any time by replying 'START'.
Explains how users can unsubscribe from receiving messages from your agent. Must describe the process for users to stop receiving communications and how your system handles these requests.
10000This account is used exclusively for sending test messages to introduce RCS capabilities to customers.
Triggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations,
and weekly promotional campaigns for opted-in users.
Defines the external events or conditions that will cause your RBM agent to initiate conversations with users. These triggers determine when and why your agent sends the first message to users.
#8860CDThe hexadecimal color code for the primary color used in UI elements. The specified color must meet WCAG 2.1 contrast ratio of 4.5:1 for legibility.
support@example.comThe contact email address for the RCS Agent.
25Customer SupportA label for the email address.
447700900001E.164 formatted phone number without + prefix
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
https://example.com25Company WebsiteA label for the website URL.
https://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkzA publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.
https://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqbA publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.
https://www.example.com/privacy-policyThe publicly accessible URL of the privacy policy for the RCS Agent.
https://www.example.com/terms-of-serviceThe publicly accessible URL of the terms of service for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was created.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was last updated.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the test device.
447700900001E.164 formatted phone number without + prefix
ACCEPTEDThe current status of the test device.
2023-01-01T12:00:00ZThe date and time when the test device was created.
att-usThe id of the carrier.
LAUNCH_STATE_UNLAUNCHEDThe launch state of the carrier.
LAUNCH_STATE_UNSPECIFIEDLAUNCH_STATE_UNLAUNCHEDLAUNCH_STATE_PENDINGLAUNCH_STATE_LAUNCHEDLAUNCH_STATE_REJECTEDLAUNCH_STATE_SUSPENDEDLAUNCH_STATE_PENDING_UNLAUNCHLAUNCH_STATE_INVALID_IN_GMBVERIFICATION_STATE_UNVERIFIEDThe verification status of the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent launch was submitted.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
Example CoThe unique display name of the RCS Agent.
ExampleCo-RCSAgent-1A unique sender identifier on the Vonage platform. This cannot be blank, include whitespaces, or be changed after creation.
The sender ID is used as the from value when sending RCS messages via the Messages API.
NORTH_AMERICAThe geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.
NORTH_AMERICAEUROPEASIA_PACIFICTRANSACTIONALSpecifies the intended use of the RCS Agent. This cannot be changed after creation.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALSpecifies the billing category of the RCS Agent.
CONVERSATIONALNON_CONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.
Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers.
If you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com.
Test the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.
Agent access instructions specify how reviewers and testers can access and interact with your RBM agent during the review and testing phases before launch. This property provides guidance on methods for triggering agent functionality and testing various features.
imageThe media type of the agent preview.
imagevideohttps://www.example.com/rcs-agent-preview.jpgThe URL to the agent preview.
A list of points of contact for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
200Technical SupportThe job title of the point of contact.
Traffic estimates for the RCS Agent.
THOUSANDEstimated global traffic.
THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MOREONCE_PER_MONTHEstimated message rate per user.
ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAYHUNDREDEstimated number of users targeted.
HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE10000This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses.
Secondary interactions may include promotional offers for existing customers and appointment scheduling assistance.
This field describes the primary and secondary types of interactions your RBM agent will have with users. It outlines the conversational patterns, message types, and engagement scenarios your agent supports.
10000This is a test environment. Customers consent to receive messages directly via request, phone, or email.
Users can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode.
Opt-in confirmation includes details about message frequency and content type.
Details how users will provide consent to receive messages from your RBM agent. This must clearly explain the opt-in mechanism and what users can expect when they subscribe to your messaging service.
10000Customers can unsubscribe from receiving messages by replying 'STOP' to any message.
They can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed,
and can re-subscribe at any time by replying 'START'.
Explains how users can unsubscribe from receiving messages from your agent. Must describe the process for users to stop receiving communications and how your system handles these requests.
10000This account is used exclusively for sending test messages to introduce RCS capabilities to customers.
Triggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations,
and weekly promotional campaigns for opted-in users.
Defines the external events or conditions that will cause your RBM agent to initiate conversations with users. These triggers determine when and why your agent sends the first message to users.
#8860CDThe hexadecimal color code for the primary color used in UI elements. The specified color must meet WCAG 2.1 contrast ratio of 4.5:1 for legibility.
support@example.comThe contact email address for the RCS Agent.
25Customer SupportA label for the email address.
447700900001E.164 formatted phone number without + prefix
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
https://example.com25Company WebsiteA label for the website URL.
https://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkzA publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.
https://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqbA publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.
https://www.example.com/privacy-policyThe publicly accessible URL of the privacy policy for the RCS Agent.
https://www.example.com/terms-of-serviceThe publicly accessible URL of the terms of service for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was created.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was last updated.
Exemplo Solicitação
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
Example CoThe unique display name of the RCS Agent.
ExampleCo-RCSAgent-1A unique sender identifier on the Vonage platform. This cannot be blank, include whitespaces, or be changed after creation.
The sender ID is used as the from value when sending RCS messages via the Messages API.
NORTH_AMERICAThe geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.
NORTH_AMERICAEUROPEASIA_PACIFICTRANSACTIONALSpecifies the intended use of the RCS Agent. This cannot be changed after creation.
PROMOTIONALTRANSACTIONALOTPMULTI_USECONVERSATIONALSpecifies the billing category of the RCS Agent.
CONVERSATIONALNON_CONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.
Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers.
If you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com.
Test the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.
Agent access instructions specify how reviewers and testers can access and interact with your RBM agent during the review and testing phases before launch. This property provides guidance on methods for triggering agent functionality and testing various features.
imageThe media type of the agent preview.
imagevideohttps://www.example.com/rcs-agent-preview.jpgThe URL to the agent preview.
A list of points of contact for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
200Technical SupportThe job title of the point of contact.
Traffic estimates for the RCS Agent.
THOUSANDEstimated global traffic.
THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MOREONCE_PER_MONTHEstimated message rate per user.
ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAYHUNDREDEstimated number of users targeted.
HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE10000This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses.
Secondary interactions may include promotional offers for existing customers and appointment scheduling assistance.
This field describes the primary and secondary types of interactions your RBM agent will have with users. It outlines the conversational patterns, message types, and engagement scenarios your agent supports.
10000This is a test environment. Customers consent to receive messages directly via request, phone, or email.
Users can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode.
Opt-in confirmation includes details about message frequency and content type.
Details how users will provide consent to receive messages from your RBM agent. This must clearly explain the opt-in mechanism and what users can expect when they subscribe to your messaging service.
10000Customers can unsubscribe from receiving messages by replying 'STOP' to any message.
They can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed,
and can re-subscribe at any time by replying 'START'.
Explains how users can unsubscribe from receiving messages from your agent. Must describe the process for users to stop receiving communications and how your system handles these requests.
10000This account is used exclusively for sending test messages to introduce RCS capabilities to customers.
Triggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations,
and weekly promotional campaigns for opted-in users.
Defines the external events or conditions that will cause your RBM agent to initiate conversations with users. These triggers determine when and why your agent sends the first message to users.
#8860CDThe hexadecimal color code for the primary color used in UI elements. The specified color must meet WCAG 2.1 contrast ratio of 4.5:1 for legibility.
support@example.comThe contact email address for the RCS Agent.
25Customer SupportA label for the email address.
447700900001E.164 formatted phone number without + prefix
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
https://example.com25Company WebsiteA label for the website URL.
https://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkzA publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.
https://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqbA publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:
- image/png
- image/jpeg
- image/jpg
Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.
https://www.example.com/privacy-policyThe publicly accessible URL of the privacy policy for the RCS Agent.
https://www.example.com/terms-of-serviceThe publicly accessible URL of the terms of service for the RCS Agent.
200JohnThe first name of the representative for the RCS Agent.
200DoeThe last name of the representative for the RCS Agent.
john.doe@example.comThe email address of the representative.
https://www.example.comThe website URL of the brand represented by the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was created.
2023-01-01T12:00:00ZThe date and time when the RCS Agent was last updated.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the test device.
447700900001E.164 formatted phone number without + prefix
ACCEPTEDThe current status of the test device.
2023-01-01T12:00:00ZThe date and time when the test device was created.
att-usThe id of the carrier.
LAUNCH_STATE_UNLAUNCHEDThe launch state of the carrier.
LAUNCH_STATE_UNSPECIFIEDLAUNCH_STATE_UNLAUNCHEDLAUNCH_STATE_PENDINGLAUNCH_STATE_LAUNCHEDLAUNCH_STATE_REJECTEDLAUNCH_STATE_SUSPENDEDLAUNCH_STATE_PENDING_UNLAUNCHLAUNCH_STATE_INVALID_IN_GMBVERIFICATION_STATE_UNVERIFIEDThe verification status of the RCS Agent.
2023-01-01T12:00:00ZThe date and time when the RCS Agent launch was submitted.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
A list of available carriers for RCS.
verizon-usA unique identifier for the carrier.
VerizonThe name of the carrier.
USCode for the country where the carrier operates.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
An array of Carrier IDs to add to the RCS Agent.
Exemplo Solicitação
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
+14155552671The phone number to add to the RCS Agent in E.164 format.
Exemplo Solicitação
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created test device.
447700900001E.164 formatted phone number without + prefix
2023-01-01T12:00:00ZThe date and time when the test device was created.
ACCEPTEDThe current status of the test device.
Exemplo Resposta
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
Operações disponíveis
Generate RCS Deeplink
Generate an RCS deeplink for a specific RCS agent and use case. See the RCS Deeplinks documentation for more information.
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
50acme_agentMessages API sender ID (a.k.a. external ID) that identifies the RCS agent.
22USISO 3166-1 alpha-2 country code of the country where the deep link will operate.
3072I'm interested in finding out about your new product. Please send me more details.Optional pre-defined message that will be populated in the send-message dialog of the SMS/RCS app on the end user's device when the user opens the deep link.
+15550123456Optional Vonage virtual number in E.164 format that will be used as the SMS fallback destination if the end user's device does not support RCS.
Exemplo Solicitação
https://tools.vonage.com/rcs/v1/deeplink/jNiLGT29KY4RVzTczcA83NFFhv28Ut-bdnutpcG8OTv-7a8vt75f3ka1eyDh3L4KZTkJ9qgXHkThe generated RCS deeplink URL.