Opérations disponibles
Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
50The maximum number of WhatsApp WABAs returned per page.
1The current page number within the set of pages.
5The total number of pages within the set of pages.
219The total number of WhatsApp WABAs within the overall record set.
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
ACTIVEWhatsApp Business Account status
ACTIVEINELIGIBLENOT_STARTEDINELIGBLE_ON_BEHALF_OF_WABAPENDINGDELETEDMIGRATEDBANNEDRESTRICTEDRATE_LIMITEDFLAGGEDCONNECTEDDISCONNECTEDUNKNOWNUNVERIFIEDOFFLINEMaximum 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_UNLIMITEDUNTIEREDOnboarding 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_SETUPONBOARDEDhttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=ascThe URL to the current page of WhatsApp WABAs.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=ascThe URL to the first page of WhatsApp WABAs.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=5&page_size=50&order=ascThe URL to the last page of WhatsApp WABAs.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=2&page_size=50&order=ascThe URL to the next page of WhatsApp WABAs.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=ascThe URL to the previous page of WhatsApp WABAs.
Exemple Réponse
{
"page_size": 50,
"page": 1,
"total_pages": 5,
"total_items": 219,
"_embedded": {
"wabas": [
{
"waba_id": "345688589250625",
"api_key": "abc123",
"name": "My Business",
"account_review_status": "Approved",
"timezone_id": "58",
"currency": "USD",
"solution_id": "1234567890",
"country": "US",
"business_id": "224654643345",
"business_name": "Vonage Communication APIs & Conversational Commerce Platform",
"status": "ACTIVE",
"whatsapp_business_manager_messaging_limit": "TIER_100K",
"marketing_messages_onboarding_status": "INELIGIBLE_ON_BEHALF_OF_WABA"
}
]
},
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc"
},
"first": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc"
},
"last": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=5&page_size=50&order=asc"
},
"next": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=2&page_size=50&order=asc"
},
"prev": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc"
}
}
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | 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
ACTIVEWhatsApp Business Account status
ACTIVEINELIGIBLENOT_STARTEDINELIGBLE_ON_BEHALF_OF_WABAPENDINGDELETEDMIGRATEDBANNEDRESTRICTEDRATE_LIMITEDFLAGGEDCONNECTEDDISCONNECTEDUNKNOWNUNVERIFIEDOFFLINEMaximum 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_UNLIMITEDUNTIEREDOnboarding 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_SETUPONBOARDEDhttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625The URL to the WhatsApp Business Account (WABA) being retrieved.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbersThe URL to list the phone numbers associated with the WhatsApp Business Account (WABA).
Exemple Réponse
{
"waba_id": "345688589250625",
"api_key": "abc123",
"name": "My Business",
"account_review_status": "Approved",
"timezone_id": "58",
"currency": "USD",
"solution_id": "1234567890",
"country": "US",
"business_id": "224654643345",
"business_name": "Vonage Communication APIs & Conversational Commerce Platform",
"status": "ACTIVE",
"whatsapp_business_manager_messaging_limit": "TIER_100K",
"marketing_messages_onboarding_status": "INELIGIBLE_ON_BEHALF_OF_WABA",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625"
},
"numbers": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers"
}
}
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
50The maximum number of WABA numbers returned per page.
1The current page number within the set of pages.
5The total number of pages within the set of pages.
219The total number of WABA numbers within the overall record set.
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.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751The URL to the current page of WhatsApp WABAs.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=1&page_size=50&order=ascThe URL to the first page of WhatsApp WABAs.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=5&page_size=50&order=ascThe URL to the last page of WhatsApp WABAs.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=2&page_size=50&order=ascThe URL to the next page of WhatsApp WABAs.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=1&page_size=50&order=ascThe URL to the previous page of WhatsApp WABAs.
Exemple Réponse
{
"page_size": 50,
"page": 1,
"total_pages": 5,
"total_items": 219,
"_embedded": {
"wabas": [
{
"phone_number": "447451277751",
"number_id": "293464193855848",
"waba_id": "345688589250625",
"api_key": "abc123",
"verified_name": "My Business",
"code_verification_status": "VERIFIED",
"display_phone_number": "+447451277751",
"messaging_limit_tier": "TIER_100K",
"quality_score": {
"score": "GREEN"
},
"throughput": {
"level": "STANDARD"
}
}
]
},
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751"
},
"first": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=1&page_size=50&order=asc"
},
"last": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=5&page_size=50&order=asc"
},
"next": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=2&page_size=50&order=asc"
},
"prev": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=1&page_size=50&order=asc"
}
}
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | 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.
https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751The URL to the WhatsApp Business Account (WABA) Number being retrieved.
Exemple Réponse
{
"phone_number": "447451277751",
"number_id": "293464193855848",
"waba_id": "345688589250625",
"api_key": "abc123",
"verified_name": "My Business",
"code_verification_status": "VERIFIED",
"display_phone_number": "+447451277751",
"messaging_limit_tier": "TIER_100K",
"quality_score": {
"score": "GREEN"
},
"throughput": {
"level": "STANDARD"
},
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751"
}
}
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | 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.
whatsapphttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751The URL to the profile being retrieved.
Exemple Réponse
{
"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",
"messaging_product": "whatsapp",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751"
}
}
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | 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_SERVICESRESTAURANTRETAILTRAVELExemple Demande
{
"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": "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.
whatsapphttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751The URL to the profile being updated.
Exemple Réponse
{
"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",
"messaging_product": "whatsapp",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751"
}
}
}Opérations disponibles
Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
123456789111213The partner solution ID.
abc123Sub-api-key of the end-client that the Partner wants to generate the ES flow URL for. If not provided, this defaults to Partner’s main api-key
25920086400300The time-to-live for the URL in seconds.
Exemple Demande
{
"solution_id": "123456789111213",
"api_key": "abc123",
"ttl": 300
}{
"solution_id": "123456789111213",
"api_key": "abc123",
"ttl": 300
}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.
Exemple Réponse
{
"id": "3amb0119-0196-42d1-8fb5-55a98s133546",
"url": "https://tools.vonage.com/wa/partners/onboard?token=fhdhhdJhbGciOiJSUzI1NiJ9.eyJleHAiOjE3MjU5Njc1OTYsImp0aSI6ImQ1MmJhNmFjLWYxZjktNDdmNC05MTR_cFT1bVfkDhP-wgpKZibSbUoh9z-9KGD-wsmHxi0h7tTidpVhPNShfC5jmgiHtOQKXXv5NWb9OqoUraOMMpqCdNdXoN3ao-PeZX7axyYW_FQ6CeV9gDEPhAZ4urTi0uW4mCYGl3ULmA9Ps92r_wi2DJyRE_Kx2KahWtQd51yVpU6FfXgMb4odREEccDctT1Peo09wKgwBa1wsOkD7rrvkoQPqZ00VXcqOY1_LOO5tq4WJaKqtxX-U7VtDo9qyVUl8pdegZW6QWChQzGN4PkqXXLWcBlyrCtAYdhtWG8q6NM_6bARRjcGJlj0tQvE0PZ9AtafAQSPpOll5lcnUK8Ds"
}Opérations disponibles
Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
Demande de renseignements Paramètres
110[
"458951126288937",
"458951126288942"
]An array of the template_ids of the template(s) to retrieve analytics for.
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 of the analytics data to be retrieved.
DAILYDAILYThe granularity of the template analytics retrieved.
DAILYcloud_apiThe product type for which the template analytics were retrieved.
100The maximum number of template analytics returned per page.
458951126288942The ID of the WhatsApp Template which the analytics data is for.
2024-11-11T00:00:00ZThe start date and time in ISO-8601 format for the analytics data to be retrieved from.
2024-11-11T00:00:00ZThe end date and time in ISO-8601 format for the analytics data to be retrieved to.
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.
Exemple Réponse
{
"granularity": "DAILY",
"product_type": "cloud_api",
"page_size": 100,
"_embedded": {
"template_analytics": [
{
"template_id": "458951126288942",
"start": "2024-11-11T00:00:00Z",
"end": "2024-11-11T00:00:00Z",
"sent": 100,
"delivered": 90,
"read": 80,
"clicked": 70
}
]
},
"_links": {
"self": {
"href": "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=c2VsZj1udWxs"
}
}
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
Demande de renseignements Paramètres
HALF_HOURThe granularity of the messaging analytics data to be retrieved.
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.
[
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 (WABA) for which the messaging analytics were retrieved.
HALF_HOURThe granularity of the template analytics retrieved.
HALF_HOURDAILYMONTHLYPhone numbers for which the messaging analytics were retrieved.
Two-letter country codes for the countries 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 within the data point range.
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.
Exemple Réponse
{
"id": "345688589250625",
"granularity": "HALF_HOUR",
"phone_numbers": [
"16505550111"
],
"country_codes": [
"US"
],
"_embedded": {
"messaging_analytics": [
{
"start": "1543543200",
"end": "1543629600",
"sent": 100,
"delivered": 90
}
]
},
"paging": {
"cursors": {
"before": "MAZDZD",
"after": "MjQZD"
},
"next": "https://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?after=MAZDZD",
"previous": "https://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?before=MjQZD"
}
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
Demande de renseignements Paramètres
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.
DAILYThe granularity of the analytics data to be retrieved.
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).
DAILYThe granularity of the pricing analytics retrieved.
DAILYcloud_apiThe product type for which the pricing analytics were retrieved.
2024-11-11T00:00:00ZThe start date and time in ISO-8601 format for the analytics data to be retrieved from.
2024-11-11T00:00:00ZThe end date and time in ISO-8601 format for the analytics data to be retrieved to.
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.
Exemple Réponse
{
"granularity": "DAILY",
"product_type": "cloud_api",
"_embedded": {
"pricing_analytics": [
{
"start": "2024-11-11T00:00:00Z",
"end": "2024-11-11T00:00:00Z",
"volume": 100,
"phone_number": "14155552671",
"country": "US",
"tier": "75000:150000",
"pricing_type": "REGULAR",
"pricing_category": "AUTHENTICATION"
}
]
},
"paging": {
"cursors": {
"before": "MjQZD",
"after": "MAZDZD"
},
"previous": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MjQZD",
"next": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MAZDZD"
}
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
2024-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
slackMy 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_onboardedThe 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
Exemple Réponse
[
{
"id": "9fa85698-c92a-4786-be0e-b5a489425120",
"type": "slack",
"label": "My WhatsApp Slack Subscription",
"whatsapp_subscribe_types": "account_alerts,account_update",
"vonage_subscribe_types": "vonage_number_onboarded",
"created_at": "2024-11-01T12:00:00Z",
"slack": {
"url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
}
},
{
"id": "8bceefe2-ebc8-4aa6-a4a3-73d837b3d416",
"type": "webhook",
"label": "My WhatsApp Webhook Subscription",
"whatsapp_subscribe_types": "account_alerts,account_update",
"vonage_subscribe_types": "vonage_number_onboarded",
"created_at": "2024-11-01T12:00:00Z",
"webhook": {
"url": "https://example.com/webhook"
}
}
]Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
slackThe type of subscription to create
slackMy 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_onboardedThe 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
Exemple Demande
{
"label": "My WhatsApp Subscription",
"whatsapp_subscribe_types": "account_alerts,account_update",
"vonage_subscribe_types": "vonage_number_onboarded",
"slack": {
"url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
},
"type": "slack"
}{
"label": "My WhatsApp Subscription",
"whatsapp_subscribe_types": "account_alerts,account_update",
"vonage_subscribe_types": "vonage_number_onboarded",
"slack": {
"url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
},
"type": "slack"
}2024-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
slackMy 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_onboardedThe 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
Exemple Réponse
{
"label": "My WhatsApp Subscription",
"whatsapp_subscribe_types": "account_alerts,account_update",
"vonage_subscribe_types": "vonage_number_onboarded",
"slack": {
"url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
},
"created_at": "2024-11-01T12:00:00Z",
"id": "9fa85698-c92a-4786-be0e-b5a489425120",
"type": "slack"
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
Opérations disponibles
RCS Capabilities Device Check
Get RCS Capabilities for a Specific Device. Please note that this operation is deprecated, please refer to this one instead.
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
A list of RCS capabilities for the device being checked.
RICHCARD,RICHCARD_CAROUSEL,CREATE_CALENDAR_EVENT,DIAL_PHONE_NUMBER,OPEN_URL,SHARE_LOCATION,VIEW_LOCATIONExemple Réponse
{
"features": [
"RICHCARD",
"RICHCARD_CAROUSEL",
"CREATE_CALENDAR_EVENT",
"DIAL_PHONE_NUMBER",
"OPEN_URL",
"SHARE_LOCATION",
"VIEW_LOCATION"
]
}Authentification
Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.
Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
+447900000000The phone number of the device to check in E.164 format.
GBThe country code of the device to check.
Exemple Demande
{
"msisdn": "+447900000000",
"country": "GB"
}{
"msisdn": "+447900000000",
"country": "GB"
}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_LOCATIONExemple Réponse
{
"rcs_supported": true,
"features": [
"RICHCARD_STANDALONE",
"ACTION_CREATE_CALENDAR_EVENT",
"ACTION_DIAL",
"ACTION_OPEN_URL",
"ACTION_SHARE_LOCATION",
"ACTION_VIEW_LOCATION",
"RICHCARD_CAROUSEL"
]
}RCS Capabilities Bulk Check
Perform an RCS Capability Check for Multiple Devices. See the RCS Capability Checks documentation for more information.
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
An array of phone numbers to check.
Exemple Demande
{
"users": [
"447900000000",
"447900000001"
]
}{
"users": [
"447900000000",
"447900000001"
]
}Opérations disponibles
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
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.
STOPSTARTCUSTOMtrueIndicates if opt-out is enabled for the user.
Exemple Réponse
{
"actions": [
{
"keywords": [
"STOP"
],
"auto-reply": "You have opted out.",
"action": "STOP"
}
],
"enabled": true
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
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.
STOPSTARTCUSTOMExemple Demande
{
"actions": [
{
"keywords": [
"STOP"
],
"auto-reply": "You have opted out.",
"action": "STOP"
}
]
}{
"actions": [
{
"keywords": [
"STOP"
],
"auto-reply": "You have opted out.",
"action": "STOP"
}
]
}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.
STOPSTARTCUSTOMtrueIndicates if opt-out is enabled for the user.
Exemple Réponse
{
"actions": [
{
"keywords": [
"STOP"
],
"auto-reply": "You have opted out.",
"action": "STOP"
}
],
"enabled": true
}Opérations disponibles
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the RCS Brand.
My RCS BrandThe name of the RCS Brand.
Exemple Réponse
[
{
"brands": [
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"display_name": "My RCS Brand"
}
]
}
]Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
100My RCS BrandThe name of the RCS Brand.
Exemple Demande
{
"display_name": "My RCS Brand"
}{
"display_name": "My RCS Brand"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
100My Updated RCS BrandThe name of the RCS Brand.
Exemple Demande
{
"display_name": "My Updated RCS Brand"
}{
"display_name": "My Updated RCS Brand"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
Demande de renseignements Paramètres
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of an RCS Brand to filter by.
DRAFTThe state of the RCS Agent to filter by.
DRAFTCREATEDVERIFIEDLAUNCHEDREJECTEDUNLAUNCHEDMULTI_USEThe agent_purpose of the RCS Agent to filter by.
OTPMULTI_USEPROMOTIONALTRANSACTIONALSINGLE_MESSAGEThe billing_category of the RCS Agent to filter by.
SINGLE_MESSAGECONVERSATIONALBASIC_MESSAGENORTH_AMERICAThe hosting_region of the RCS Agent to filter by.
NORTH_AMERICAEUROPEASIA_PACIFIC10The number of results to return per page. Default is 20.
ascThe order in which to return the results.
ascdesc2The page number to return. Default is 1.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
0198095f-f18a-7f75-aa0a-59c3dfd68802The id of the RCS Brand with which to associate this agent.
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_USEBASIC_MESSAGESpecifies the pricing model applied to messages sent via this RCS Agent.
BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
#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.
+1234567890End-user contact number in E.164 format.
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
25Company WebsiteA label for the website URL.
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.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this 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.
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.
200JaneThe first name of the point of contact.
200SmithThe last name of the point of contact.
jane.smith@example.comThe email address of the point of contact.
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.
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.
+1234567890The phone number of the test device in E.164 format.
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.
The link for the current page.
https://api.nexmo.com/v1/channel-manager/rcs/agents?page=1The link for the next page.
https://api.nexmo.com/v1/channel-manager/rcs/agents?page=1The link for the previous page.
https://api.nexmo.com/v1/channel-manager/rcs/agents?page=101The current page number.
10The number of items per page.
100The total number of items.
10The total number of pages.
Exemple Réponse
{
"_embedded": {
"agents": [
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"state": "DRAFT",
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
},
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-01-01T12:00:00Z",
"test_devices": [
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"phone": "+1234567890",
"status": "ACCEPTED",
"created_at": "2023-01-01T12:00:00Z"
}
],
"carriers": {
"id": "att-us",
"launch_state": "LAUNCH_STATE_UNLAUNCHED"
},
"verification_details": {
"status": "VERIFICATION_STATE_UNVERIFIED"
},
"launch_submitted_at": "2023-01-01T12:00:00Z"
}
]
},
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/channel-manager/rcs/agents?page=1"
},
"first": {
"href": "https://api.nexmo.com/v1/channel-manager/rcs/agents?page=1"
},
"last": {
"href": "https://api.nexmo.com/v1/channel-manager/rcs/agents?page=10"
}
},
"page": 1,
"page_size": 10,
"total_items": 100,
"total_pages": 10
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
0198095f-f18a-7f75-aa0a-59c3dfd68802The id of the RCS Brand with which to associate this agent.
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_USEBASIC_MESSAGESpecifies the pricing model applied to messages sent via this RCS Agent.
BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
#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.
+1234567890End-user contact number in E.164 format.
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
25Company WebsiteA label for the website URL.
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.
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.
200JaneThe first name of the point of contact.
200SmithThe last name of the point of contact.
jane.smith@example.comThe email address of the point of contact.
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.
Exemple Demande
{
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
}
}{
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
}
}78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
0198095f-f18a-7f75-aa0a-59c3dfd68802The id of the RCS Brand with which to associate this agent.
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_USEBASIC_MESSAGESpecifies the pricing model applied to messages sent via this RCS Agent.
BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
#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.
+1234567890End-user contact number in E.164 format.
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
25Company WebsiteA label for the website URL.
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.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this 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.
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.
200JaneThe first name of the point of contact.
200SmithThe last name of the point of contact.
jane.smith@example.comThe email address of the point of contact.
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.
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.
Exemple Réponse
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"state": "DRAFT",
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
},
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-01-01T12:00:00Z"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
0198095f-f18a-7f75-aa0a-59c3dfd68802The id of the RCS Brand with which to associate this agent.
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_USEBASIC_MESSAGESpecifies the pricing model applied to messages sent via this RCS Agent.
BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
#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.
+1234567890End-user contact number in E.164 format.
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
25Company WebsiteA label for the website URL.
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.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this 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.
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.
200JaneThe first name of the point of contact.
200SmithThe last name of the point of contact.
jane.smith@example.comThe email address of the point of contact.
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.
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.
+1234567890The phone number of the test device in E.164 format.
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.
Exemple Réponse
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"state": "DRAFT",
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
},
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-01-01T12:00:00Z",
"test_devices": [
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"phone": "+1234567890",
"status": "ACCEPTED",
"created_at": "2023-01-01T12:00:00Z"
}
],
"carriers": {
"id": "att-us",
"launch_state": "LAUNCH_STATE_UNLAUNCHED"
},
"verification_details": {
"status": "VERIFICATION_STATE_UNVERIFIED"
},
"launch_submitted_at": "2023-01-01T12:00:00Z"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
0198095f-f18a-7f75-aa0a-59c3dfd68802The id of the RCS Brand with which to associate this agent.
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_USEBASIC_MESSAGESpecifies the pricing model applied to messages sent via this RCS Agent.
BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
#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.
+1234567890End-user contact number in E.164 format.
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
25Company WebsiteA label for the website URL.
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.
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.
200JaneThe first name of the point of contact.
200SmithThe last name of the point of contact.
jane.smith@example.comThe email address of the point of contact.
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.
Exemple Demande
{
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
}
}{
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
}
}78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
0198095f-f18a-7f75-aa0a-59c3dfd68802The id of the RCS Brand with which to associate this agent.
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_USEBASIC_MESSAGESpecifies the pricing model applied to messages sent via this RCS Agent.
BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
#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.
+1234567890End-user contact number in E.164 format.
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
25Company WebsiteA label for the website URL.
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.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this 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.
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.
200JaneThe first name of the point of contact.
200SmithThe last name of the point of contact.
jane.smith@example.comThe email address of the point of contact.
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.
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.
+1234567890The phone number of the test device in E.164 format.
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.
Exemple Réponse
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"state": "DRAFT",
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
},
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-01-01T12:00:00Z",
"test_devices": [
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"phone": "+1234567890",
"status": "ACCEPTED",
"created_at": "2023-01-01T12:00:00Z"
}
],
"carriers": {
"id": "att-us",
"launch_state": "LAUNCH_STATE_UNLAUNCHED"
},
"verification_details": {
"status": "VERIFICATION_STATE_UNVERIFIED"
},
"launch_submitted_at": "2023-01-01T12:00:00Z"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this agent.
0198095f-f18a-7f75-aa0a-59c3dfd68802The id of the RCS Brand with which to associate this agent.
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_USEBASIC_MESSAGESpecifies the pricing model applied to messages sent via this RCS Agent.
BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
#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.
+1234567890End-user contact number in E.164 format.
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
25Company WebsiteA label for the website URL.
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.
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.
200JaneThe first name of the point of contact.
200SmithThe last name of the point of contact.
jane.smith@example.comThe email address of the point of contact.
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.
Exemple Demande
{
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
}
}{
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
}
}78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created RCS Agent.
DRAFTThe current state of the created RCS Agent.
0198095f-f18a-7f75-aa0a-59c3dfd68802The id of the RCS Brand with which to associate this agent.
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_USEBASIC_MESSAGESpecifies the pricing model applied to messages sent via this RCS Agent.
BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALThis agent is used for transactional messages only.Additional notes or comments about the RCS Agent.
#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.
+1234567890End-user contact number in E.164 format.
25Customer SupportA label for the phone number.
100Your trusted partner in messaging.A short phrase that represents the RCS Agent.
25Company WebsiteA label for the website URL.
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.
78d335fa-323d-0114-9c3d-d6f0d48968cfThe id of the Vonage application with which to associate this 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.
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.
200JaneThe first name of the point of contact.
200SmithThe last name of the point of contact.
jane.smith@example.comThe email address of the point of contact.
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.
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.
+1234567890The phone number of the test device in E.164 format.
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.
Exemple Réponse
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"state": "DRAFT",
"basic_info": {
"brand_id": "0198095f-f18a-7f75-aa0a-59c3dfd68802",
"display_name": "Example Co",
"sender_id": "ExampleCo-RCSAgent-1",
"hosting_region": "NORTH_AMERICA",
"agent_purpose": "TRANSACTIONAL",
"billing_category": "BASIC_MESSAGE",
"notes": "This agent is used for transactional messages only."
},
"visual_design": {
"brand_color": "#8860CD",
"email": {
"address": "support@example.com",
"label": "Customer Support"
},
"phone": {
"number": "+1234567890",
"label": "Customer Support"
},
"tagline": "Your trusted partner in messaging.",
"website": {
"address": "https://www.example.com"
},
"privacy_policy": "https://www.example.com/privacy-policy",
"terms_of_service": "https://www.example.com/terms-of-service"
},
"application_settings": {
"application_id": "78d335fa-323d-0114-9c3d-d6f0d48968cf"
},
"representative": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"brand_website": "https://www.example.com"
},
"carrier_requirements": {
"agent_preview": {
"agent_access_instructions": "Provide a method for reviewers to trigger the agent, such as a website where reviewers can invite and add phone numbers. \nIf you need a list of phone numbers to add as test devices, contact rbm-support@vonage.com. \nTest the agent by sending a keyword like 'HELP' or 'START' to initiate conversation flow.\n",
"urls": [
{
"media_type": "image",
"url": "https://www.example.com/rcs-agent-preview.jpg"
}
]
},
"points_of_contact": [
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"job_title": "Technical Support"
}
],
"traffic_estimates": {
"average_global_traffic": "THOUSAND",
"average_message_rate_per_user": "ONCE_PER_MONTH",
"users_targeted": "HUNDRED"
},
"user_experience": {
"interactions_description": "This agent handles customer support inquiries and provides product information. Primary interactions include order status updates, account notifications, and FAQ responses. \nSecondary interactions may include promotional offers for existing customers and appointment scheduling assistance.\n",
"optin_description": "This is a test environment. Customers consent to receive messages directly via request, phone, or email. \nUsers can opt-in by visiting our website and providing their phone number, or by texting 'JOIN' to our SMS shortcode. \nOpt-in confirmation includes details about message frequency and content type.\n",
"optout_description": "Customers can unsubscribe from receiving messages by replying 'STOP' to any message. \nThey can also contact us by email at support@company.com. Users will receive a confirmation message when successfully unsubscribed, \nand can re-subscribe at any time by replying 'START'.\n",
"trigger_description": "This account is used exclusively for sending test messages to introduce RCS capabilities to customers. \nTriggers include: order placement confirmations, shipping notifications, appointment reminders, customer service escalations, \nand weekly promotional campaigns for opted-in users.\n"
}
},
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-01-01T12:00:00Z",
"test_devices": [
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"phone": "+1234567890",
"status": "ACCEPTED",
"created_at": "2023-01-01T12:00:00Z"
}
],
"carriers": {
"id": "att-us",
"launch_state": "LAUNCH_STATE_UNLAUNCHED"
},
"verification_details": {
"status": "VERIFICATION_STATE_UNVERIFIED"
},
"launch_submitted_at": "2023-01-01T12:00:00Z"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | 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.
Exemple Réponse
{
"carriers": [
{
"id": "verizon-us",
"carrier": "Verizon",
"country_letter_code": "US"
}
]
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
An array of Carrier IDs to add to the RCS Agent.
Exemple Demande
{
"carriers": [
"verizon-us"
]
}{
"carriers": [
"verizon-us"
]
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |
+14155552671The phone number to add to the RCS Agent in E.164 format.
Exemple Demande
{
"phone": "+14155552671"
}{
"phone": "+14155552671"
}78d335fa-323d-0114-9c3d-d6f0d48968cfThe unique ID of the created test device.
+14155552671The phone number to add to the RCS Agent in E.164 format.
2023-01-01T12:00:00ZThe date and time when the test device was created.
ACCEPTEDThe current status of the test device.
Exemple Réponse
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"phone": "+14155552671",
"created_at": "2023-01-01T12:00:00Z",
"status": "ACCEPTED"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Clé et secret de l'API encodés en Base64 et reliés par deux points. | Headers | Basic <base64> |