Channel Manager API

The Channel Manager API provides a way of managing configuration and data related to various messaging channels in the Vonage Messages API. Find out more at https://developer.vonage.com/en/api/channel-manager.

Descargar la especificación OpenAPI

WhatsApp WABAs

API endpoints relating to working with WhatsApp Business Accounts (WABAs)

Operaciones disponibles

List WhatsApp Business Accounts (WABAs)

List all WhatsApp Business Accounts (WABAs) that are associated with the Vonage account.

gethttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas

Autenticación

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

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

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

Consulta Parámetros

page

integer

Min1

Por defecto1

ejemplo1

Page number to retrieve

page_size

integer

Min1

Por defecto10

ejemplo20

Number of items to return per page

order

string

The order.

Debe ser uno de:ascdesc

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

page_size

integer

Min1

Por defecto10

ejemplo20

The size of the page

page

integer

Min1

Por defecto1

ejemplo1

The current page

total_pages

integer

Min1

ejemplo42

Total number of pages

total_items

integer

ejemplo871

The total number of items in the resource list

_embedded

object

wabas

array

waba_id

string

Requerido

ejemplo345688589250625

The ID of the WhatsApp Business Account.

api_key

string

Requerido

ejemploabc123

The API key of the Vonage account associated with the WhatsApp Business Account.

name

string

Requerido

ejemploMy Business

The name of the WhatsApp Business Account.

account_review_status

string

Requerido

ejemploApproved

The review status of the WhatsApp Business Account.

Debe ser uno de:PendingApprovedRejected

timezone_id

string

Requerido

ejemplo58

The ID of the timezone of the WhatsApp Business Account.

currency

string

Requerido

ejemploUSD

The currency of the WhatsApp Business Account.

solution_id

string

ejemplo1234567890

The ID of the solution of the WhatsApp Business Account. Applies for WABAs onboarded through a partner solution

country

string

ejemploUS

The country of the WhatsApp Business Account's owning Meta Business account.

business_id

string

ejemplo224654643345

ID of the business manager or portfolio that contains the WhatsApp Business Account

business_name

string

ejemploVonage Communication APIs & Conversational Commerce Platform

Name of the business manager or portfolio that contains the WhatsApp Business Account

status

string

Por defectoACTIVE

ejemploACTIVE

WhatsApp Business Account status

Debe ser uno de:ACTIVEINELIGIBLENOT_STARTEDINELIGBLE_ON_BEHALF_OF_WABAPENDINGDELETEDMIGRATEDBANNEDRESTRICTEDRATE_LIMITEDFLAGGEDCONNECTEDDISCONNECTEDUNKNOWNUNVERIFIEDOFFLINE

whatsapp_business_manager_messaging_limit

string

ejemploTIER_10K

Maximum 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.

Debe ser uno de:TIER_100KTIER_10KTIER_250TIER_2KTIER_UNLIMITEDUNTIERED

marketing_messages_onboarding_status

string

ejemploELIGIBLE

Onboarding status of the WhatsApp Business account into Marketing Messages API.

Debe ser uno de:INELIGIBLE_ON_BEHALF_OF_WABAINELIGIBLE_INACTIVE_OR_RESTRICTEDINELIGIBLE_COUNTRY_NOT_SUPPORTEDINELIGIBLE_USING_WHATSAPP_BUSINESS_APPELIGIBLEPENDING_VALID_PAYMENT_METHODPENDING_INTERNAL_SETUPONBOARDED

_links

object

HAL links for page-based paginated collections

self

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

first

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

last

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

Get a specific WhatsApp Business Account (WABA)

Retreive details of a specific WhatsApp Business Account (WABA).

gethttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id

Autenticación

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

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

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

Ruta Parámetros

waba_id

string

Requerido

ejemplo345688589250625

The waba_id of the WhatsApp Business Account (WABA).

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

waba_id

string

Requerido

ejemplo345688589250625

The ID of the WhatsApp Business Account.

api_key

string

Requerido

ejemploabc123

The API key of the Vonage account associated with the WhatsApp Business Account.

name

string

Requerido

ejemploMy Business

The name of the WhatsApp Business Account.

account_review_status

string

Requerido

ejemploApproved

The review status of the WhatsApp Business Account.

Debe ser uno de:PendingApprovedRejected

timezone_id

string

Requerido

ejemplo58

The ID of the timezone of the WhatsApp Business Account.

currency

string

Requerido

ejemploUSD

The currency of the WhatsApp Business Account.

solution_id

string

ejemplo1234567890

The ID of the solution of the WhatsApp Business Account. Applies for WABAs onboarded through a partner solution

country

string

ejemploUS

The country of the WhatsApp Business Account's owning Meta Business account.

business_id

string

ejemplo224654643345

ID of the business manager or portfolio that contains the WhatsApp Business Account

business_name

string

ejemploVonage Communication APIs & Conversational Commerce Platform

Name of the business manager or portfolio that contains the WhatsApp Business Account

status

string

Por defectoACTIVE

ejemploACTIVE

WhatsApp Business Account status

Debe ser uno de:ACTIVEINELIGIBLENOT_STARTEDINELIGBLE_ON_BEHALF_OF_WABAPENDINGDELETEDMIGRATEDBANNEDRESTRICTEDRATE_LIMITEDFLAGGEDCONNECTEDDISCONNECTEDUNKNOWNUNVERIFIEDOFFLINE

whatsapp_business_manager_messaging_limit

string

ejemploTIER_10K

For more information on messaging limits see the Meta documentation.

Debe ser uno de:TIER_100KTIER_10KTIER_250TIER_2KTIER_UNLIMITEDUNTIERED

marketing_messages_onboarding_status

string

ejemploELIGIBLE

Onboarding status of the WhatsApp Business account into Marketing Messages API.

_links

object

self

object

Link to the current resource (always required in HAL)

self

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

numbers

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

List Numbers for a WhatsApp Business Account (WABA)

List all Numbers associated with a WhatsApp Business Account (WABA).

gethttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/numbers

Autenticación

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

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

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

Ruta Parámetros

waba_id

string

Requerido

ejemplo345688589250625

The waba_id of the WhatsApp Business Account (WABA).

Consulta Parámetros

page

integer

Min1

Por defecto1

ejemplo1

Page number to retrieve

page_size

integer

Min1

Por defecto10

ejemplo20

Number of items to return per page

order

string

The order.

Debe ser uno de:ascdesc

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

page_size

integer

Min1

Por defecto10

ejemplo20

The size of the page

page

integer

Min1

Por defecto1

ejemplo1

The current page

total_pages

integer

Min1

ejemplo42

Total number of pages

total_items

integer

ejemplo871

The total number of items in the resource list

_embedded

object

wabas

array

phone_number

string(e164)

Requerido

ejemplo447451277751

The phone number associated with the WhatsApp Business Account.

number_id

string

Requerido

ejemplo293464193855848

The ID of the phone number associated with the WhatsApp Business Account.

waba_id

string

Requerido

ejemplo345688589250625

The ID of the WhatsApp Business Account.

api_key

string

Requerido

ejemploabc123

The API key of the Vonage account associated with the WhatsApp Business Account.

verified_name

string

ejemploMy Business

The WhatsApp display name for number

code_verification_status

string

ejemploVERIFIED

Indicates the phone number's one-time password (OTP) verification status.

Only phone numbers with a VERIFIED status can be registered.
An EXPIRED status 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.

Debe ser uno de:NOT_VERIFIEDVERIFIEDEXPIRED

display_phone_number

string

ejemplo+447451277751

How the number is displayed on WhatsApp accounts.

messaging_limit_tier

string

ejemploTIER_100K

The messaging limit tier of the phone number. See WhatsApp messaging limits

Debe ser uno de:TIER_50TIER_250TIER_1KTIER_10KTIER_100KTIER_UNLIMITED

quality_score

object

The quality score of the phone number. See WhatsApp Business phone number’s quality rating

score

string

ejemploGREEN

The quality score of the phone number.

GREEN: High quality
YELLOW: Medium quality
RED: Low quality

Debe ser uno de:GREENYELLOWRED

throughput

object

The throughput level of the phone number. Indication of throughput permissible by WhatsApp e.g. STANDARD is the default 80 messages/sec

level

string

ejemploSTANDARD

The throughput rate of the phone number.

_links

object

HAL links for page-based paginated collections

self

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

first

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

last

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

Get a specific WhatsApp Business Account (WABA) Number

Retreive details of a specific Number associated with a WhatsApp Business Account (WABA).

gethttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/numbers/:whatsapp_number

Autenticación

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

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

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

Ruta Parámetros

waba_id

string

Requerido

ejemplo345688589250625

The waba_id of the WhatsApp Business Account (WABA).

whatsapp_number

string(e164)

Requerido

ejemplo447451277751

The WhatsApp number.

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

phone_number

string(e164)

Requerido

ejemplo447451277751

The phone number associated with the WhatsApp Business Account.

number_id

string

Requerido

ejemplo293464193855848

The ID of the phone number associated with the WhatsApp Business Account.

waba_id

string

Requerido

ejemplo345688589250625

The ID of the WhatsApp Business Account.

api_key

string

Requerido

ejemploabc123

The API key of the Vonage account associated with the WhatsApp Business Account.

verified_name

string

ejemploMy Business

The WhatsApp display name for number

code_verification_status

string

ejemploVERIFIED

Indicates the phone number's one-time password (OTP) verification status.

Only phone numbers with a VERIFIED status can be registered.
An EXPIRED status 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.

Debe ser uno de:NOT_VERIFIEDVERIFIEDEXPIRED

display_phone_number

string

ejemplo+447451277751

How the number is displayed on WhatsApp accounts.

messaging_limit_tier

string

ejemploTIER_100K

The messaging limit tier of the phone number. See WhatsApp messaging limits

Debe ser uno de:TIER_50TIER_250TIER_1KTIER_10KTIER_100KTIER_UNLIMITED

quality_score

object

The quality score of the phone number. See WhatsApp Business phone number’s quality rating

score

string

ejemploGREEN

The quality score of the phone number.

GREEN: High quality
YELLOW: Medium quality
RED: Low quality

Debe ser uno de:GREENYELLOWRED

throughput

object

The throughput level of the phone number. Indication of throughput permissible by WhatsApp e.g. STANDARD is the default 80 messages/sec

level

string

ejemploSTANDARD

The throughput rate of the phone number.

_links

object

self

object

Link to the current resource (always required in HAL)

self

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

Get the profile for a specific WhatsApp Business Account (WABA) Number

Retreive details of the profile for a specific Number associated with a WhatsApp Business Account (WABA).

gethttps://api.nexmo.com/v1/channel-manager/whatsapp/numbers/:whatsapp_number/profile

Autenticación

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

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

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

Ruta Parámetros

whatsapp_number

string(e164)

Requerido

ejemplo447451277751

The WhatsApp number.

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

about

string

ejemploAbout my business

Information about the profile

address

string

ejemplo123 Main Street, Anytown, USA

The address of the profile

description

string

ejemploDescription of my business

The description of the profile

string

ejemplobob@example.com

The email address of the profile

profile_picture_url

string(uri)

ejemplohttps://example.com/profile.png

URL 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

websites

array

URLs of websites for the profile

vertical

string

ejemploOTHER

The Industry or Business Category of the WhatsApp Profile

Debe ser uno de:APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVEL

messaging_product

string

ejemplowhatsapp

The messaging product with which the profile is associated.

Debe ser uno de:whatsapp

_links

object

self

object

Link to the current resource (always required in HAL)

self

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

Update the profile for a specific WhatsApp Business Account (WABA) Number

Update details of the profile for a specific Number associated with a WhatsApp Business Account (WABA).

patchhttps://api.nexmo.com/v1/channel-manager/whatsapp/numbers/:whatsapp_number/profile

Autenticación

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

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

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

Ruta Parámetros

whatsapp_number

string(e164)

Requerido

ejemplo447451277751

The WhatsApp number.

Cuerpo de la solicitud
Tipo de contenido
application/json

about

string

ejemploAbout my business

Information about the profile

address

string

ejemplo123 Main Street, Anytown, USA

The address of the profile

description

string

ejemploDescription of my business

The description of the profile

string

ejemplobob@example.com

The email address of the profile

profile_picture_url

string(uri)

ejemplohttps://example.com/profile.png

websites

array

URLs of websites for the profile

vertical

string

ejemploOTHER

The Industry or Business Category of the WhatsApp Profile

Debe ser uno de:APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVEL

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

about

string

ejemploAbout my business

Information about the profile

address

string

ejemplo123 Main Street, Anytown, USA

The address of the profile

description

string

ejemploDescription of my business

The description of the profile

string

ejemplobob@example.com

The email address of the profile

profile_picture_url

string(uri)

ejemplohttps://example.com/profile.png

websites

array

URLs of websites for the profile

vertical

string

ejemploOTHER

The Industry or Business Category of the WhatsApp Profile

Debe ser uno de:APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVEL

messaging_product

string

ejemplowhatsapp

The messaging product with which the profile is associated.

Debe ser uno de:whatsapp

_links

object

self

object

Link to the current resource (always required in HAL)

self

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

WhatsApp Hosted ES Flow

API endpoints relating to working with WhatsApp Hosted Embedded Sign-up Flows

Operaciones disponibles

Generate Hosted ES Flow URL

Generate Hosted ES Flow URL

Generate a URL for the start page for WhatsApp hosted embedded sign-up flow based on the supplied partner solution ID.

posthttps://api.nexmo.com/v1/channel-manager/whatsapp/tp-registration/url

Autenticación

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

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

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

Cuerpo de la solicitud
Tipo de contenido
application/json

solution_id

string

Requerido

ejemplo123456789111213

The partner solution ID.

api_key

string

ejemploabc123

The API key of the Vonage account associated with the WhatsApp Business Account.

ttl

integer

Max259200

Por defecto86400

ejemplo300

The time-to-live for the URL in seconds.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string

Requerido

ejemplo3amb0119-0196-42d1-8fb5-55a98s133546

The trace ID for the URL generation request.

url

string

Requerido

ejemplo

https://tools.vonage.com/wa/partners/onboard?token=fhdhhdJhbGciOiJSUzI1NiJ9.eyJleHAiOjE3MjU5Njc1OTYsImp0aSI6ImQ1MmJhNmFjLWYxZjktNDdmNC05MTR_cFT1bVfkDhP-wgpKZibSbUoh9z-9KGD-wsmHxi0h7tTidpVhPNShfC5jmgiHtOQKXXv5NWb9OqoUraOMMpqCdNdXoN3ao-PeZX7axyYW_FQ6CeV9gDEPhAZ4urTi0uW4mCYGl3ULmA9Ps92r_wi2DJyRE_Kx2KahWtQd51yVpU6FfXgMb4odREEccDctT1Peo09wKgwBa1wsOkD7rrvkoQPqZ00VXcqOY1_LOO5tq4WJaKqtxX-U7VtDo9qyVUl8pdegZW6QWChQzGN4PkqXXLWcBlyrCtAYdhtWG8q6NM_6bARRjcGJlj0tQvE0PZ9AtafAQSPpOll5lcnUK8Ds

URL containing tokenized information and redirecting to ES flow start page.

Ejemplo Respuesta

WhatsApp Analytics

API endpoints relating to analytics data for WhatsApp

Operaciones disponibles

Get Template Analytics

Get analytics for a specific template.

gethttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/template-analytics

Autenticación

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

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

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

Ruta Parámetros

waba_id

string

Requerido

ejemplo345688589250625

The waba_id of the WhatsApp Business Account (WABA).

Consulta Parámetros

template_ids

array

An array of the template_ids of the WhatsApp template(s).

start

string(timestamp)

ejemplo2024-11-01

The start date and time in ISO-8601 format for the analytics data to be retrieved from, in the format YYYY-MM-DD.

end

string(timestamp)

ejemplo2024-11-03

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

metric_types

array

ejemplo

[
  "SENT",
  "DELIVERED"
]

An array of the metric types to retrieve analytics for. Possible values are SENT, DELIVERED, READ, and CLICKED.

Valores disponibles:

SENT,DELIVERED,READ,CLICKED

granularity

string

ejemploDAILY

The granularity at which you would like to retrieve the template analytics.

Debe ser uno de:DAILY

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

granularity

string

ejemploDAILY

Debe ser uno de:DAILY

product_type

string

ejemploCLOUD_API

The product type for which the template analytics were retrieved.

Debe ser uno de:CLOUD_APIMARKETING_MESSAGES_API_FOR_WHATSAPP

page_size

integer

ejemplo100

The maximum number of template analytics returned per page.

_embedded

object

template_analytics

array

template_id

string

Requerido

ejemplo458951126288942

The ID of the WhatsApp Template which the analytics data is for.

start

string(timestamp)

Requerido

ejemplo1543543200

The UNIX timestamp for the start of the data point range.

end

string(timestamp)

Requerido

ejemplo1543629600

The UNIX timestamp for the end of the data point range.

sent

integer

ejemplo100

The number of messages sent using the WhatsApp Template.

delivered

integer

ejemplo90

The number of messages delivered using the WhatsApp Template.

read

integer

ejemplo80

The number of messages read using the WhatsApp Template.

clicked

integer

ejemplo70

The number of messages clicked using the WhatsApp Template.

_links

object

self

object

href

string

ejemplo

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

The URL to the current page of WhatsApp Template Analytics.

Ejemplo Respuesta

Get Messaging Analytics

Get analytics for WhatsApp messages

gethttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/messaging-analytics

Autenticación

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

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

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

Ruta Parámetros

waba_id

string

Requerido

ejemplo345688589250625

The waba_id of the WhatsApp Business Account (WABA).

Consulta Parámetros

granularity

string

ejemploDAILY

The granularity at which you would like to retrieve the analytics.

Debe ser uno de:HALF_HOURDAILYMONTHLY

start

string(timestamp)

ejemplo2024-11-01

The start date and time in ISO-8601 format for the analytics data to be retrieved from, in the format YYYY-MM-DD.

end

string(timestamp)

ejemplo2024-11-03

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

product_types

array

ejemplo

[
  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.

Valores disponibles:

0,2

phone_numbers

array

ejemplo

[
  "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.

country_codes

array

ejemplo

[
  "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.

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string

ejemplo345688589250625

The ID of the WhatsApp Business Account.

granularity

string

ejemploDAILY

Debe ser uno de:HALF_HOURDAILYMONTHLY

phone_numbers

array

Phone numbers for which the messaging analytics were retrieved.

country_codes

array

_embedded

object

messaging_analytics

array

start

string(timestamp)

Requerido

ejemplo1543543200

The UNIX timestamp for the start of the data point range.

end

string(timestamp)

Requerido

ejemplo1543629600

The UNIX timestamp for the end of the data point range.

sent

integer

Requerido

ejemplo100

The number of messages sent using the WhatsApp Template.

delivered

integer

Requerido

ejemplo90

The number of messages delivered within the data point range.

paging

object

cursors

object

before

string

ejemploMAZDZD

The page before the first page in the current list

after

string

ejemploMjQZD

The page after the last page in the current list

string(uri)

ejemplohttps://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?after=MAZDZD

A URI to ge the next paginated page.

string(uri)

ejemplohttps://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?before=MjQZD

A URI to ge the previous paginated page.

Ejemplo Respuesta

Get Pricing Analytics

Get analytics for message pricing.

gethttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/pricing-analytics

Autenticación

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

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

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

Ruta Parámetros

waba_id

string

Requerido

ejemplo345688589250625

The waba_id of the WhatsApp Business Account (WABA).

Consulta Parámetros

start

string(timestamp)

ejemplo2024-11-01

The start date and time in ISO-8601 format for the analytics data to be retrieved from, in the format YYYY-MM-DD.

end

string(timestamp)

ejemplo2024-11-03

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

granularity

string

ejemploDAILY

The granularity at which you would like to retrieve the analytics.

Debe ser uno de:HALF_HOURDAILYMONTHLY

phone_numbers

array

ejemplo

[
  "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.

country_codes

array

ejemplo

[
  "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.

dimensions

array

ejemplo

[
  "PRICING_CATEGORY"
]

List of breakdowns you would like to apply to your metrics. If empty, all results returned without any breakdowns.

Valores disponibles:

PRICING_CATEGORY,PRICING_TYPE,COUNTRY,PHONE,TIER

tier

array

ejemplo

[
  "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).

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

granularity

string

ejemploDAILY

Debe ser uno de:HALF_HOURDAILYMONTHLY

product_type

string

ejemploREGULAR

The product type for which the pricing analytics were retrieved.

Debe ser uno de:FREE_CUSTOMER_SERVICEFREE_ENTRY_POINTREGULAR

_embedded

object

pricing_analytics

array

start

string(timestamp)

ejemplo1543543200

The UNIX timestamp for the start of the data point range.

end

string(timestamp)

ejemplo1543629600

The UNIX timestamp for the end of the data point range.

volume

integer

ejemplo100

The number of messages sent.

phone_number

string(e164)

ejemplo14155552671

The phone number associated with the Messaging Analytics.

country

string

ejemploUS

The country for the phone number associated with the Messaging Analytics.

tier

string

ejemplo75000:150000

The pricing tier for the messages related to the Messaging Analytics.

pricing_type

string

ejemploREGULAR

The pricing type for the messages related to the Messaging Analytics.

pricing_category

string

ejemploAUTHENTICATION

The pricing category for the messages related to the Messaging Analytics.

paging

object

cursors

object

before

string

ejemploMjQZD

The cursor the previous page of WhatsApp Pricing Analytics.

after

string

ejemploMAZDZD

The cursor the next page of WhatsApp Pricing Analytics.

string

ejemplohttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MjQZD

The URL to the previous page of WhatsApp Pricing Analytics.

string

ejemplohttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MAZDZD

The URL to the next page of WhatsApp Pricing Analytics.

Ejemplo Respuesta

Enable template analytics

Before you can fetch template analytics, Meta guidelines ask you to enable "insights". This endpoint will enable insights

patchhttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/enable_insights

Autenticación

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

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

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

Ruta Parámetros

waba_id

string

Requerido

ejemplo345688589250625

The waba_id of the WhatsApp Business Account (WABA).

Respuestas

No Content - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

WhatsApp Notification Subscriptions

API endpoints relating to subscriptions for WhatsApp Notification

Operaciones disponibles

List Notification Subscriptions

Get a list of all notification subscriptions for the main API key

gethttps://api.nexmo.com/v2/whatsapp-manager/subscriptions

Autenticación

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

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

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

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

array

Cualquiera de

label

string

ejemploMy WhatsApp Subscription

An optional label for the subscription

whatsapp_subscribe_types

string

ejemploaccount_alerts,account_update

A 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_subscribe_types

string

ejemplovonage_number_onboarded

A comma-separated list of the Vonage notification types that the subscription is for.

Debe ser uno de:vonage_number_onboarded

created_at

string

ejemplo2024-11-01T12:00:00Z

The date and time when the subscription was created, in ISO-8601 format.

string

ejemplo9fa85698-c92a-4786-be0e-b5a489425120

The unique ID of the subscription

type

string

ejemploslack

The subscription type

Debe ser uno de:slack

slack

object

Requerido

The Slack hook configuration for the subscription, where the subscription type is slack.

url

string(uri)

Requerido

ejemplohttps://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

The URL of the Slack hook to which the WhatsApp notifications will be sent

Ejemplo Respuesta

Create a Notification Subscription

Create a new notification subscription for the main API key

posthttps://api.nexmo.com/v2/whatsapp-manager/subscriptions

Autenticación

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

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

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

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de

label

string

ejemploMy WhatsApp Subscription

An optional label for the subscription

whatsapp_subscribe_types

string

ejemploaccount_alerts,account_update

vonage_subscribe_types

string

ejemplovonage_number_onboarded

A comma-separated list of the Vonage notification types that the subscription is for.

Debe ser uno de:vonage_number_onboarded

created_at

string

ejemplo2024-11-01T12:00:00Z

The date and time when the subscription was created, in ISO-8601 format.

string

ejemplo9fa85698-c92a-4786-be0e-b5a489425120

The unique ID of the subscription

type

string

ejemploslack

The subscription type

Debe ser uno de:slack

slack

object

Requerido

The Slack hook configuration for the subscription, where the subscription type is slack.

url

string(uri)

Requerido

ejemplohttps://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

The URL of the Slack hook to which the WhatsApp notifications will be sent

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

Uno de

label

string

ejemploMy WhatsApp Subscription

An optional label for the subscription

whatsapp_subscribe_types

string

ejemploaccount_alerts,account_update

vonage_subscribe_types

string

ejemplovonage_number_onboarded

A comma-separated list of the Vonage notification types that the subscription is for.

Debe ser uno de:vonage_number_onboarded

created_at

string

ejemplo2024-11-01T12:00:00Z

The date and time when the subscription was created, in ISO-8601 format.

string

ejemplo9fa85698-c92a-4786-be0e-b5a489425120

The unique ID of the subscription

type

string

ejemploslack

The subscription type

Debe ser uno de:slack

slack

object

Requerido

The Slack hook configuration for the subscription, where the subscription type is slack.

url

string(uri)

Requerido

ejemplohttps://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

The URL of the Slack hook to which the WhatsApp notifications will be sent

Ejemplo Respuesta

Delete a Notification Subscription

Delete a notification subscription for the main API key

deletehttps://api.nexmo.com/v2/whatsapp-manager/subscriptions/:subscription_id

Autenticación

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

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

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

Ruta Parámetros

subscription_id

string

Requerido

ejemplo9fa85698-c92a-4786-be0e-b5a489425120

The ID of the notification subscription to delete.

Respuestas

No Content - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

RCS Capability Checks

API endpoints relating to checking RCS capabilities of a device or devices

Operaciones 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.

gethttps://api.nexmo.com/v1/channel-manager/rcs/agents/:sender_id/google/phones/:phone_number/capabilities

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`

Ruta Parámetros

sender_id

string

Requerido

ejemploVonageAgent

The Sender ID of your RCS Agent.

phone_number

string(e164)

Requerido

ejemplo447700900001

The phone number of the device to check.

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

features

array

A list of RCS capabilities for the device being checked.

Valores disponibles:

RICHCARD_STANDALONE,RICHCARD_CAROUSEL,ACTION_CREATE_CALENDAR_EVENT,ACTION_DIAL,ACTION_OPEN_URL,ACTION_SHARE_LOCATION,ACTION_VIEW_LOCATION

Ejemplo Respuesta

RCS Capabilities Device Check

Get RCS Capabilities for a Specific Device

posthttps://api.nexmo.com/v1/channel-manager/rcs/agents/:sender_id/devices/capabilities

Autenticación

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

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

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

Ruta Parámetros

sender_id

string

Requerido

ejemploVonageAgent

The Sender ID of your RCS Agent.

Cuerpo de la solicitud
Tipo de contenido
application/json

msisdn

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

country

string

Requerido

ejemploGB

The country code of the device to check.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

rcs_supported

boolean

ejemplotrue

Indicates if RCS is supported on the device.

features

array

A list of RCS capabilities for the device being checked.

Valores disponibles:

RICHCARD_STANDALONE,RICHCARD_CAROUSEL,ACTION_CREATE_CALENDAR_EVENT,ACTION_DIAL,ACTION_OPEN_URL,ACTION_SHARE_LOCATION,ACTION_VIEW_LOCATION

Ejemplo Respuesta

RCS Capabilities Bulk Check

Perform an RCS Capability Check for Multiple Devices. See the RCS Capability Checks documentation for more information.

posthttps://api.nexmo.com/v1/channel-manager/rcs/agents/:sender_id/google/:operation

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Su token web JSON. Más información sobre los JWT	Headers	`Bearer <JWT>`

Ruta Parámetros

sender_id

string

Requerido

ejemploVonageAgent

The Sender ID of your RCS Agent.

operation

string

Requerido

The operation to perform.

Debe ser uno de:users:batchGet

Cuerpo de la solicitud
Tipo de contenido
application/json

users

array

An array of phone numbers to check.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

Uno de

reachableUsers

array

A list of specific numbers for devices that reachable for RCS messaging.

Ejemplo Respuesta»Response where 500 numbers or less submitted.

RCS Opt-out Management

API endpoints relating to managing RCS opt-outs

Operaciones disponibles

Get Opt-out Information

Retrieve RCS Opt-out information. Note: this feature is only available to accounts with RCS enabled; please contact your Vonage representative for more information.

gethttps://api.nexmo.com/v1/channel-manager/rcs/opt-out/:sender_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

sender_id

string

Requerido

ejemploVonageAgent

The Sender ID of your RCS Agent.

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

enabled

boolean

ejemplotrue

Indicates if opt-out is enabled for the user.

actions

array

Requerido

A list of actions available for opt-out.

keywords

array

Requerido

A list of keywords that trigger the action.

auto-reply

string

Requerido

ejemploYou have opted out.

The auto-reply message sent when the action is triggered.

action

string

Requerido

ejemploSTOP

The type of action.

Debe ser uno de:STOPSTARTCUSTOM

Ejemplo Respuesta

Update Opt-out Information

Update RCS Opt-out information. Note: this feature is only available to accounts with RCS enabled; please contact your Vonage representative for more information.

posthttps://api.nexmo.com/v1/channel-manager/rcs/opt-out/:sender_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

sender_id

string

Requerido

ejemploVonageAgent

The Sender ID of your RCS Agent.

Cuerpo de la solicitud
Tipo de contenido
application/json

enabled

boolean

ejemplotrue

Indicates if opt-out is enabled for the user.

actions

array

Requerido

A list of actions available for opt-out.

keywords

array

Requerido

A list of keywords that trigger the action.

auto-reply

string

Requerido

ejemploYou have opted out.

The auto-reply message sent when the action is triggered.

action

string

Requerido

ejemploSTOP

The type of action.

Debe ser uno de:STOPSTARTCUSTOM

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

enabled

boolean

ejemplotrue

Indicates if opt-out is enabled for the user.

actions

array

Requerido

A list of actions available for opt-out.

keywords

array

Requerido

A list of keywords that trigger the action.

auto-reply

string

Requerido

ejemploYou have opted out.

The auto-reply message sent when the action is triggered.

action

string

Requerido

ejemploSTOP

The type of action.

Debe ser uno de:STOPSTARTCUSTOM

Ejemplo Respuesta

RCS Brand Management

API endpoints relating to managing RCS Brands

Operaciones disponibles

List Brands (Deprecated)

Retrieve a list of RCS Brands. Deprecated, please use the v2 endpoint instead.

gethttps://api.nexmo.com/v1/channel-manager/rcs/brands

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

array

brands

array

Requerido

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploMy RCS Brand

The name of the RCS Brand.

Ejemplo Respuesta

Create Brand (Deprecated)

Create a new RCS Brand. Deprecated, please use the v2 endpoint instead.

posthttps://api.nexmo.com/v1/channel-manager/rcs/brands

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

display_name

string

Requerido

ejemploMy RCS Brand

The name of the RCS Brand.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Created

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploMy RCS Brand

The name of the RCS Brand.

Ejemplo Respuesta

Update Brand (Deprecated)

Update an existing RCS Brand. Deprecated, please use the v2 endpoint instead.

patchhttps://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

brand_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The Id of the Brand.

Cuerpo de la solicitud
Tipo de contenido
application/json

display_name

string

Requerido

ejemploMy RCS Brand

The name of the RCS Brand.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploMy RCS Brand

The name of the RCS Brand.

Ejemplo Respuesta

Delete Brand (Deprecated)

Delete an existing RCS Brand. Deprecated, please use the v2 endpoint instead.

deletehttps://api.nexmo.com/v1/channel-manager/rcs/brands/:brand_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

brand_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The Id of the Brand.

Respuestas

No Content - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

List Brands

Retrieve a list of RCS Brands.

gethttps://api.nexmo.com/v2/channel-manager/rcs/brands

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

array

brands

array

Requerido

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

Max100

ejemploMy RCS Brand

The name of the RCS Brand.

details

object

organization_name

string

Requerido

Max255

ejemploAcme Corporation

Legal organization name

legal_form

string

Requerido

Max50

ejemploLimited liability company (LLC)

Legal form of the organization. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values for US entities:

Limited liability company (LLC)
Corporation (C-corp)
Benefit Corporation (B-corp)
Partnership (General or Limited)
Nonprofit or Foundation
Sole proprietorship

Standard values for non-US entities:

Private limited company
Public limited company
Sole proprietorship
Partnership
Nonprofit or Foundation

Custom values are accepted when none of the above apply.

stock_symbol

string

Max12

ejemploACME

Stock symbol of the organization, if publicly traded

legal_entity_type

string

Requerido

Max50

ejemploPrivate

Type of legal entity. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values:

Public
Private
Government
Non-profit
Sole proprietor

Custom values are accepted when none of the above apply.

country_of_registration

string

Requerido

Min2

Max2

ejemploUS

ISO 3166-1 alpha-2 country code of registration

federal_tax_id

string

Max50

ejemplo12-3456789

Federal tax identification number (required for US entities)

business_website_url

string

Requerido

Max255

ejemplohttps://www.example.com

Business website URL of the organization

address_line1

string

Requerido

Max255

ejemploOne Main Street

Primary address line

address_line2

string

Max255

ejemploSuite 100

Secondary address line

city

string

Requerido

Max100

ejemploSan Francisco

City name

state_or_province

string

Requerido

Max100

ejemploCalifornia

State or province name

zip_or_post_code

string

Requerido

Max15

ejemploSW1A 1AA

ZIP or postal code

Ejemplo Respuesta

Create Brand

Create a new RCS Brand.

posthttps://api.nexmo.com/v2/channel-manager/rcs/brands

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

display_name

string

Requerido

Max100

ejemploMy RCS Brand

The name of the RCS Brand.

details

object

organization_name

string

Requerido

Max255

ejemploAcme Corporation

Legal organization name

legal_form

string

Requerido

Max50

ejemploLimited liability company (LLC)

Legal form of the organization. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values for US entities:

Limited liability company (LLC)
Corporation (C-corp)
Benefit Corporation (B-corp)
Partnership (General or Limited)
Nonprofit or Foundation
Sole proprietorship

Standard values for non-US entities:

Private limited company
Public limited company
Sole proprietorship
Partnership
Nonprofit or Foundation

Custom values are accepted when none of the above apply.

stock_symbol

string

Max12

ejemploACME

Stock symbol of the organization, if publicly traded

legal_entity_type

string

Requerido

Max50

ejemploPrivate

Type of legal entity. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values:

Public
Private
Government
Non-profit
Sole proprietor

Custom values are accepted when none of the above apply.

country_of_registration

string

Requerido

Min2

Max2

ejemploUS

ISO 3166-1 alpha-2 country code of registration

federal_tax_id

string

Max50

ejemplo12-3456789

Federal tax identification number (required for US entities)

business_website_url

string

Requerido

Max255

ejemplohttps://www.example.com

Business website URL of the organization

address_line1

string

Requerido

Max255

ejemploOne Main Street

Primary address line

address_line2

string

Max255

ejemploSuite 100

Secondary address line

city

string

Requerido

Max100

ejemploSan Francisco

City name

state_or_province

string

Requerido

Max100

ejemploCalifornia

State or province name

zip_or_post_code

string

Requerido

Max15

ejemploSW1A 1AA

ZIP or postal code

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

Max100

ejemploMy RCS Brand

The name of the RCS Brand.

details

object

organization_name

string

Requerido

Max255

ejemploAcme Corporation

Legal organization name

legal_form

string

Requerido

Max50

ejemploLimited liability company (LLC)

Legal form of the organization. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values for US entities:

Limited liability company (LLC)
Corporation (C-corp)
Benefit Corporation (B-corp)
Partnership (General or Limited)
Nonprofit or Foundation
Sole proprietorship

Standard values for non-US entities:

Private limited company
Public limited company
Sole proprietorship
Partnership
Nonprofit or Foundation

Custom values are accepted when none of the above apply.

stock_symbol

string

Max12

ejemploACME

Stock symbol of the organization, if publicly traded

legal_entity_type

string

Requerido

Max50

ejemploPrivate

Type of legal entity. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values:

Public
Private
Government
Non-profit
Sole proprietor

Custom values are accepted when none of the above apply.

country_of_registration

string

Requerido

Min2

Max2

ejemploUS

ISO 3166-1 alpha-2 country code of registration

federal_tax_id

string

Max50

ejemplo12-3456789

Federal tax identification number (required for US entities)

business_website_url

string

Requerido

Max255

ejemplohttps://www.example.com

Business website URL of the organization

address_line1

string

Requerido

Max255

ejemploOne Main Street

Primary address line

address_line2

string

Max255

ejemploSuite 100

Secondary address line

city

string

Requerido

Max100

ejemploSan Francisco

City name

state_or_province

string

Requerido

Max100

ejemploCalifornia

State or province name

zip_or_post_code

string

Requerido

Max15

ejemploSW1A 1AA

ZIP or postal code

Ejemplo Respuesta

Update Brand

Update an existing RCS Brand.

patchhttps://api.nexmo.com/v2/channel-manager/rcs/brands/:brand_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

brand_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The Id of the Brand.

Cuerpo de la solicitud
Tipo de contenido
application/json

display_name

string

Max100

ejemploMy RCS Brand

The name of the RCS Brand.

details

object

organization_name

string

Requerido

Max255

ejemploAcme Corporation

Legal organization name

legal_form

string

Requerido

Max50

ejemploLimited liability company (LLC)

Legal form of the organization. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values for US entities:

Limited liability company (LLC)
Corporation (C-corp)
Benefit Corporation (B-corp)
Partnership (General or Limited)
Nonprofit or Foundation
Sole proprietorship

Standard values for non-US entities:

Private limited company
Public limited company
Sole proprietorship
Partnership
Nonprofit or Foundation

Custom values are accepted when none of the above apply.

stock_symbol

string

Max12

ejemploACME

Stock symbol of the organization, if publicly traded

legal_entity_type

string

Requerido

Max50

ejemploPrivate

Type of legal entity. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values:

Public
Private
Government
Non-profit
Sole proprietor

Custom values are accepted when none of the above apply.

country_of_registration

string

Requerido

Min2

Max2

ejemploUS

ISO 3166-1 alpha-2 country code of registration

federal_tax_id

string

Max50

ejemplo12-3456789

Federal tax identification number (required for US entities)

business_website_url

string

Requerido

Max255

ejemplohttps://www.example.com

Business website URL of the organization

address_line1

string

Requerido

Max255

ejemploOne Main Street

Primary address line

address_line2

string

Max255

ejemploSuite 100

Secondary address line

city

string

Requerido

Max100

ejemploSan Francisco

City name

state_or_province

string

Requerido

Max100

ejemploCalifornia

State or province name

zip_or_post_code

string

Requerido

Max15

ejemploSW1A 1AA

ZIP or postal code

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

Max100

ejemploMy RCS Brand

The name of the RCS Brand.

details

object

organization_name

string

Requerido

Max255

ejemploAcme Corporation

Legal organization name

legal_form

string

Requerido

Max50

ejemploLimited liability company (LLC)

Legal form of the organization. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values for US entities:

Limited liability company (LLC)
Corporation (C-corp)
Benefit Corporation (B-corp)
Partnership (General or Limited)
Nonprofit or Foundation
Sole proprietorship

Standard values for non-US entities:

Private limited company
Public limited company
Sole proprietorship
Partnership
Nonprofit or Foundation

Custom values are accepted when none of the above apply.

stock_symbol

string

Max12

ejemploACME

Stock symbol of the organization, if publicly traded

legal_entity_type

string

Requerido

Max50

ejemploPrivate

Type of legal entity. When a standard value matches your case, use it exactly as listed to ensure consistency.

Standard values:

Public
Private
Government
Non-profit
Sole proprietor

Custom values are accepted when none of the above apply.

country_of_registration

string

Requerido

Min2

Max2

ejemploUS

ISO 3166-1 alpha-2 country code of registration

federal_tax_id

string

Max50

ejemplo12-3456789

Federal tax identification number (required for US entities)

business_website_url

string

Requerido

Max255

ejemplohttps://www.example.com

Business website URL of the organization

address_line1

string

Requerido

Max255

ejemploOne Main Street

Primary address line

address_line2

string

Max255

ejemploSuite 100

Secondary address line

city

string

Requerido

Max100

ejemploSan Francisco

City name

state_or_province

string

Requerido

Max100

ejemploCalifornia

State or province name

zip_or_post_code

string

Requerido

Max15

ejemploSW1A 1AA

ZIP or postal code

Ejemplo Respuesta

Delete Brand

Delete an existing RCS Brand.

deletehttps://api.nexmo.com/v2/channel-manager/rcs/brands/:brand_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

brand_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The Id of the Brand.

Respuestas

No Content - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

RCS Agent Management

API endpoints relating to managing RCS Agents

Operaciones disponibles

List Agents (Deprecated)

Retrieve a list of RCS Agents. Deprecated, please use the v2 endpoint instead.

gethttps://api.nexmo.com/v1/channel-manager/rcs/agents

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

brand_id

string(uuid)

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

The id of an RCS Brand to filter by.

state

string

ejemploDRAFT

The state of the RCS Agent to filter by.

Debe ser uno de:DRAFTCREATEDVERIFIEDLAUNCHEDREJECTEDUNLAUNCHED

agent_purpose

string

ejemploTRANSACTIONAL

The agent_purpose of the RCS Agent to filter by.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

ejemploCONVERSATIONAL

The billing_category of the RCS Agent to filter by.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

hosting_region

string

ejemploNORTH_AMERICA

The hosting_region of the RCS Agent to filter by.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

page

integer

Min1

Por defecto1

ejemplo1

Page number to retrieve

page_size

integer

Min1

Por defecto10

ejemplo20

Number of items to return per page

order

string

The order.

Debe ser uno de:ascdesc

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

page

integer

Requerido

Min1

Por defecto1

ejemplo1

The current page

page_size

integer

Requerido

Min1

Por defecto10

ejemplo20

The size of the page

total_items

integer

Requerido

ejemplo871

The total number of items in the resource list

total_pages

integer

Requerido

Min1

ejemplo42

Total number of pages

_embedded

object

Requerido

agents

array

Requerido

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created RCS Agent.

state

string

ejemploDRAFT

The current state of the created RCS Agent.

application_settings

object

application_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the Vonage application with which to associate this agent.

basic_info

object

Requerido

brand_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploExample Co

The unique display name of the RCS Agent.

sender_id

string

Requerido

ejemploExampleCo-RCSAgentv1-1

A 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.

hosting_region

string

Requerido

ejemploNORTH_AMERICA

The geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Specifies the intended use of the RCS Agent. This cannot be changed after creation.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Specifies the billing category of the RCS Agent.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

notes

string

ejemploThis agent is used for transactional messages only.

Additional notes or comments about the RCS Agent.

DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.

carrier_requirements

object

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

ejemplo

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.

urls

array

media_type

string

Requerido

ejemploimage

The media type of the agent preview.

Debe ser uno de:imagevideo

url

string(uri)

ejemplohttps://www.example.com/rcs-agent-preview.jpg

The URL to the agent preview.

points_of_contact

array

Requerido

A list of points of contact for the RCS Agent.

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

job_title

string

Requerido

Max200

ejemploTechnical Support

The job title of the point of contact.

traffic_estimates

object

Requerido

Traffic estimates for the RCS Agent.

average_global_traffic

string

Requerido

ejemploTHOUSAND

Estimated global traffic.

Debe ser uno de:THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MORE

average_message_rate_per_user

string

Requerido

ejemploONCE_PER_MONTH

Estimated message rate per user.

Debe ser uno de:ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAY

users_targeted

string

Requerido

ejemploHUNDRED

Estimated number of users targeted.

Debe ser uno de:HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE

user_experience

object

Requerido

interactions_description

string

Requerido

Max10000

ejemplo

This 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.

optin_description

string

Requerido

Max10000

ejemplo

This 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.

optout_description

string

Requerido

Max10000

ejemplo

Customers 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.

trigger_description

string

Requerido

Max10000

ejemplo

This 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.

visual_design

object

brand_color

string

Requerido

ejemplo#8860CD

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

array

Requerido

address

string

Requerido

ejemplosupport@example.com

The contact email address for the RCS Agent.

label

string

Max25

ejemploCustomer Support

A label for the email address.

phone

array

Requerido

number

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

label

string

Max25

ejemploCustomer Support

A label for the phone number.

tagline

string

Requerido

Max100

ejemploYour trusted partner in messaging.

A short phrase that represents the RCS Agent.

website

array

Requerido

url

string(uri)

Requerido

ejemplohttps://example.com

label

string

Max25

ejemploCompany Website

A label for the website URL.

logo_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkz

A publicly available URL of the logo image for the RCS Agent. The image must be 224px x 224px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 50 KB. Supported types:

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.

banner_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqb

A publicly available URL of the hero image for the RCS Agent. The image must be 1440px x 448px, with minimum contrast ratio of 4.5:1 against a white background. Maximum file size of 200 KB. Supported types:

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.

privacy_policy

string(uri)

ejemplohttps://www.example.com/privacy-policy

The publicly accessible URL of the privacy policy for the RCS Agent.

terms_of_service

string(uri)

ejemplohttps://www.example.com/terms-of-service

The publicly accessible URL of the terms of service for the RCS Agent.

representative

object

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

created_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was created.

updated_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was last updated.

test_devices

array

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the test device.

phone

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

status

string

Requerido

ejemploACCEPTED

The current status of the test device.

created_at

string

Requerido

ejemplo2023-01-01T12:00:00Z

The date and time when the test device was created.

carriers

object

string

Requerido

ejemploatt-us

The id of the carrier.

launch_state

string

ejemploLAUNCH_STATE_UNLAUNCHED

The launch state of the carrier.

Debe ser uno de:LAUNCH_STATE_UNSPECIFIEDLAUNCH_STATE_UNLAUNCHEDLAUNCH_STATE_PENDINGLAUNCH_STATE_LAUNCHEDLAUNCH_STATE_REJECTEDLAUNCH_STATE_SUSPENDEDLAUNCH_STATE_PENDING_UNLAUNCHLAUNCH_STATE_INVALID_IN_GMB

verification_details

object

status

string

ejemploVERIFICATION_STATE_UNVERIFIED

The verification status of the RCS Agent.

launch_submitted_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent launch was submitted.

_links

object

Requerido

HAL links for page-based paginated collections

self

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

first

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

last

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

Create Agent (Deprecated)

Create a new RCS Agent. Deprecated, please use the v2 endpoint instead.

posthttps://api.nexmo.com/v1/channel-manager/rcs/agents

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created RCS Agent.

state

string

ejemploDRAFT

The current state of the created RCS Agent.

application_settings

object

application_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the Vonage application with which to associate this agent.

basic_info

object

Requerido

brand_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploExample Co

The unique display name of the RCS Agent.

sender_id

string

Requerido

ejemploExampleCo-RCSAgentv1-1

hosting_region

string

Requerido

ejemploNORTH_AMERICA

The geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Specifies the intended use of the RCS Agent. This cannot be changed after creation.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Specifies the billing category of the RCS Agent.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

notes

string

ejemploThis agent is used for transactional messages only.

Additional notes or comments about the RCS Agent.

DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.

carrier_requirements

object

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

ejemplo

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.

urls

array

media_type

string

Requerido

ejemploimage

The media type of the agent preview.

Debe ser uno de:imagevideo

url

string(uri)

ejemplohttps://www.example.com/rcs-agent-preview.jpg

The URL to the agent preview.

points_of_contact

array

Requerido

A list of points of contact for the RCS Agent.

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

job_title

string

Requerido

Max200

ejemploTechnical Support

The job title of the point of contact.

traffic_estimates

object

Requerido

Traffic estimates for the RCS Agent.

average_global_traffic

string

Requerido

ejemploTHOUSAND

Estimated global traffic.

Debe ser uno de:THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MORE

average_message_rate_per_user

string

Requerido

ejemploONCE_PER_MONTH

Estimated message rate per user.

Debe ser uno de:ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAY

users_targeted

string

Requerido

ejemploHUNDRED

Estimated number of users targeted.

Debe ser uno de:HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE

user_experience

object

Requerido

interactions_description

string

Requerido

Max10000

ejemplo

This 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.

optin_description

string

Requerido

Max10000

ejemplo

This 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.

optout_description

string

Requerido

Max10000

ejemplo

Customers 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.

trigger_description

string

Requerido

Max10000

ejemplo

This 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.

visual_design

object

brand_color

string

Requerido

ejemplo#8860CD

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

array

Requerido

address

string

Requerido

ejemplosupport@example.com

The contact email address for the RCS Agent.

label

string

Max25

ejemploCustomer Support

A label for the email address.

phone

array

Requerido

number

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

label

string

Max25

ejemploCustomer Support

A label for the phone number.

tagline

string

Requerido

Max100

ejemploYour trusted partner in messaging.

A short phrase that represents the RCS Agent.

website

array

Requerido

url

string(uri)

Requerido

ejemplohttps://example.com

label

string

Max25

ejemploCompany Website

A label for the website URL.

logo_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkz

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.

banner_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqb

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.

privacy_policy

string(uri)

ejemplohttps://www.example.com/privacy-policy

The publicly accessible URL of the privacy policy for the RCS Agent.

terms_of_service

string(uri)

ejemplohttps://www.example.com/terms-of-service

The publicly accessible URL of the terms of service for the RCS Agent.

representative

object

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

created_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was created.

updated_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was last updated.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Created

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created RCS Agent.

state

string

ejemploDRAFT

The current state of the created RCS Agent.

application_settings

object

application_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the Vonage application with which to associate this agent.

basic_info

object

Requerido

brand_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploExample Co

The unique display name of the RCS Agent.

sender_id

string

Requerido

ejemploExampleCo-RCSAgentv1-1

hosting_region

string

Requerido

ejemploNORTH_AMERICA

The geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Specifies the intended use of the RCS Agent. This cannot be changed after creation.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Specifies the billing category of the RCS Agent.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

notes

string

ejemploThis agent is used for transactional messages only.

Additional notes or comments about the RCS Agent.

DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.

carrier_requirements

object

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

ejemplo

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.

urls

array

media_type

string

Requerido

ejemploimage

The media type of the agent preview.

Debe ser uno de:imagevideo

url

string(uri)

ejemplohttps://www.example.com/rcs-agent-preview.jpg

The URL to the agent preview.

points_of_contact

array

Requerido

A list of points of contact for the RCS Agent.

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

job_title

string

Requerido

Max200

ejemploTechnical Support

The job title of the point of contact.

traffic_estimates

object

Requerido

Traffic estimates for the RCS Agent.

average_global_traffic

string

Requerido

ejemploTHOUSAND

Estimated global traffic.

Debe ser uno de:THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MORE

average_message_rate_per_user

string

Requerido

ejemploONCE_PER_MONTH

Estimated message rate per user.

Debe ser uno de:ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAY

users_targeted

string

Requerido

ejemploHUNDRED

Estimated number of users targeted.

Debe ser uno de:HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE

user_experience

object

Requerido

interactions_description

string

Requerido

Max10000

ejemplo

This 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.

optin_description

string

Requerido

Max10000

ejemplo

This 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.

optout_description

string

Requerido

Max10000

ejemplo

Customers 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.

trigger_description

string

Requerido

Max10000

ejemplo

This 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.

visual_design

object

brand_color

string

Requerido

ejemplo#8860CD

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

array

Requerido

address

string

Requerido

ejemplosupport@example.com

The contact email address for the RCS Agent.

label

string

Max25

ejemploCustomer Support

A label for the email address.

phone

array

Requerido

number

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

label

string

Max25

ejemploCustomer Support

A label for the phone number.

tagline

string

Requerido

Max100

ejemploYour trusted partner in messaging.

A short phrase that represents the RCS Agent.

website

array

Requerido

url

string(uri)

Requerido

ejemplohttps://example.com

label

string

Max25

ejemploCompany Website

A label for the website URL.

logo_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkz

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.

banner_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqb

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.

privacy_policy

string(uri)

ejemplohttps://www.example.com/privacy-policy

The publicly accessible URL of the privacy policy for the RCS Agent.

terms_of_service

string(uri)

ejemplohttps://www.example.com/terms-of-service

The publicly accessible URL of the terms of service for the RCS Agent.

representative

object

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

created_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was created.

updated_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was last updated.

Ejemplo Respuesta

Get Agent (Deprecated)

Retrieve an existing RCS Agent. Deprecated, please use the v2 endpoint instead.

gethttps://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created RCS Agent.

state

string

ejemploDRAFT

The current state of the created RCS Agent.

application_settings

object

application_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the Vonage application with which to associate this agent.

basic_info

object

Requerido

brand_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploExample Co

The unique display name of the RCS Agent.

sender_id

string

Requerido

ejemploExampleCo-RCSAgentv1-1

hosting_region

string

Requerido

ejemploNORTH_AMERICA

The geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Specifies the intended use of the RCS Agent. This cannot be changed after creation.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Specifies the billing category of the RCS Agent.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

notes

string

ejemploThis agent is used for transactional messages only.

Additional notes or comments about the RCS Agent.

DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.

carrier_requirements

object

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

ejemplo

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.

urls

array

media_type

string

Requerido

ejemploimage

The media type of the agent preview.

Debe ser uno de:imagevideo

url

string(uri)

ejemplohttps://www.example.com/rcs-agent-preview.jpg

The URL to the agent preview.

points_of_contact

array

Requerido

A list of points of contact for the RCS Agent.

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

job_title

string

Requerido

Max200

ejemploTechnical Support

The job title of the point of contact.

traffic_estimates

object

Requerido

Traffic estimates for the RCS Agent.

average_global_traffic

string

Requerido

ejemploTHOUSAND

Estimated global traffic.

Debe ser uno de:THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MORE

average_message_rate_per_user

string

Requerido

ejemploONCE_PER_MONTH

Estimated message rate per user.

Debe ser uno de:ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAY

users_targeted

string

Requerido

ejemploHUNDRED

Estimated number of users targeted.

Debe ser uno de:HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE

user_experience

object

Requerido

interactions_description

string

Requerido

Max10000

ejemplo

This 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.

optin_description

string

Requerido

Max10000

ejemplo

This 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.

optout_description

string

Requerido

Max10000

ejemplo

Customers 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.

trigger_description

string

Requerido

Max10000

ejemplo

This 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.

visual_design

object

brand_color

string

Requerido

ejemplo#8860CD

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

array

Requerido

address

string

Requerido

ejemplosupport@example.com

The contact email address for the RCS Agent.

label

string

Max25

ejemploCustomer Support

A label for the email address.

phone

array

Requerido

number

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

label

string

Max25

ejemploCustomer Support

A label for the phone number.

tagline

string

Requerido

Max100

ejemploYour trusted partner in messaging.

A short phrase that represents the RCS Agent.

website

array

Requerido

url

string(uri)

Requerido

ejemplohttps://example.com

label

string

Max25

ejemploCompany Website

A label for the website URL.

logo_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkz

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.

banner_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqb

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.

privacy_policy

string(uri)

ejemplohttps://www.example.com/privacy-policy

The publicly accessible URL of the privacy policy for the RCS Agent.

terms_of_service

string(uri)

ejemplohttps://www.example.com/terms-of-service

The publicly accessible URL of the terms of service for the RCS Agent.

representative

object

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

created_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was created.

updated_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was last updated.

test_devices

array

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the test device.

phone

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

status

string

Requerido

ejemploACCEPTED

The current status of the test device.

created_at

string

Requerido

ejemplo2023-01-01T12:00:00Z

The date and time when the test device was created.

carriers

object

string

Requerido

ejemploatt-us

The id of the carrier.

launch_state

string

ejemploLAUNCH_STATE_UNLAUNCHED

The launch state of the carrier.

verification_details

object

status

string

ejemploVERIFICATION_STATE_UNVERIFIED

The verification status of the RCS Agent.

launch_submitted_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent launch was submitted.

Ejemplo Respuesta

Update Agent (Deprecated)

Fully update an existing RCS Agent. Deprecated, please use the v2 endpoint instead.

puthttps://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Cuerpo de la solicitud
Tipo de contenido
application/json

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created RCS Agent.

state

string

ejemploDRAFT

The current state of the created RCS Agent.

application_settings

object

application_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the Vonage application with which to associate this agent.

basic_info

object

Requerido

brand_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploExample Co

The unique display name of the RCS Agent.

sender_id

string

Requerido

ejemploExampleCo-RCSAgentv1-1

hosting_region

string

Requerido

ejemploNORTH_AMERICA

The geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Specifies the intended use of the RCS Agent. This cannot be changed after creation.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Specifies the billing category of the RCS Agent.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

notes

string

ejemploThis agent is used for transactional messages only.

Additional notes or comments about the RCS Agent.

DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.

carrier_requirements

object

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

ejemplo

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.

urls

array

media_type

string

Requerido

ejemploimage

The media type of the agent preview.

Debe ser uno de:imagevideo

url

string(uri)

ejemplohttps://www.example.com/rcs-agent-preview.jpg

The URL to the agent preview.

points_of_contact

array

Requerido

A list of points of contact for the RCS Agent.

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

job_title

string

Requerido

Max200

ejemploTechnical Support

The job title of the point of contact.

traffic_estimates

object

Requerido

Traffic estimates for the RCS Agent.

average_global_traffic

string

Requerido

ejemploTHOUSAND

Estimated global traffic.

Debe ser uno de:THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MORE

average_message_rate_per_user

string

Requerido

ejemploONCE_PER_MONTH

Estimated message rate per user.

Debe ser uno de:ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAY

users_targeted

string

Requerido

ejemploHUNDRED

Estimated number of users targeted.

Debe ser uno de:HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE

user_experience

object

Requerido

interactions_description

string

Requerido

Max10000

ejemplo

This 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.

optin_description

string

Requerido

Max10000

ejemplo

This 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.

optout_description

string

Requerido

Max10000

ejemplo

Customers 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.

trigger_description

string

Requerido

Max10000

ejemplo

This 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.

visual_design

object

brand_color

string

Requerido

ejemplo#8860CD

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

array

Requerido

address

string

Requerido

ejemplosupport@example.com

The contact email address for the RCS Agent.

label

string

Max25

ejemploCustomer Support

A label for the email address.

phone

array

Requerido

number

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

label

string

Max25

ejemploCustomer Support

A label for the phone number.

tagline

string

Requerido

Max100

ejemploYour trusted partner in messaging.

A short phrase that represents the RCS Agent.

website

array

Requerido

url

string(uri)

Requerido

ejemplohttps://example.com

label

string

Max25

ejemploCompany Website

A label for the website URL.

logo_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkz

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.

banner_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqb

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.

privacy_policy

string(uri)

ejemplohttps://www.example.com/privacy-policy

The publicly accessible URL of the privacy policy for the RCS Agent.

terms_of_service

string(uri)

ejemplohttps://www.example.com/terms-of-service

The publicly accessible URL of the terms of service for the RCS Agent.

representative

object

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

created_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was created.

updated_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was last updated.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created RCS Agent.

state

string

ejemploDRAFT

The current state of the created RCS Agent.

application_settings

object

application_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the Vonage application with which to associate this agent.

basic_info

object

Requerido

brand_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploExample Co

The unique display name of the RCS Agent.

sender_id

string

Requerido

ejemploExampleCo-RCSAgentv1-1

hosting_region

string

Requerido

ejemploNORTH_AMERICA

The geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Specifies the intended use of the RCS Agent. This cannot be changed after creation.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Specifies the billing category of the RCS Agent.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

notes

string

ejemploThis agent is used for transactional messages only.

Additional notes or comments about the RCS Agent.

DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.

carrier_requirements

object

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

ejemplo

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.

urls

array

media_type

string

Requerido

ejemploimage

The media type of the agent preview.

Debe ser uno de:imagevideo

url

string(uri)

ejemplohttps://www.example.com/rcs-agent-preview.jpg

The URL to the agent preview.

points_of_contact

array

Requerido

A list of points of contact for the RCS Agent.

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

job_title

string

Requerido

Max200

ejemploTechnical Support

The job title of the point of contact.

traffic_estimates

object

Requerido

Traffic estimates for the RCS Agent.

average_global_traffic

string

Requerido

ejemploTHOUSAND

Estimated global traffic.

Debe ser uno de:THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MORE

average_message_rate_per_user

string

Requerido

ejemploONCE_PER_MONTH

Estimated message rate per user.

Debe ser uno de:ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAY

users_targeted

string

Requerido

ejemploHUNDRED

Estimated number of users targeted.

Debe ser uno de:HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE

user_experience

object

Requerido

interactions_description

string

Requerido

Max10000

ejemplo

This 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.

optin_description

string

Requerido

Max10000

ejemplo

This 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.

optout_description

string

Requerido

Max10000

ejemplo

Customers 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.

trigger_description

string

Requerido

Max10000

ejemplo

This 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.

visual_design

object

brand_color

string

Requerido

ejemplo#8860CD

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

array

Requerido

address

string

Requerido

ejemplosupport@example.com

The contact email address for the RCS Agent.

label

string

Max25

ejemploCustomer Support

A label for the email address.

phone

array

Requerido

number

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

label

string

Max25

ejemploCustomer Support

A label for the phone number.

tagline

string

Requerido

Max100

ejemploYour trusted partner in messaging.

A short phrase that represents the RCS Agent.

website

array

Requerido

url

string(uri)

Requerido

ejemplohttps://example.com

label

string

Max25

ejemploCompany Website

A label for the website URL.

logo_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkz

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.

banner_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqb

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.

privacy_policy

string(uri)

ejemplohttps://www.example.com/privacy-policy

The publicly accessible URL of the privacy policy for the RCS Agent.

terms_of_service

string(uri)

ejemplohttps://www.example.com/terms-of-service

The publicly accessible URL of the terms of service for the RCS Agent.

representative

object

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

created_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was created.

updated_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was last updated.

test_devices

array

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the test device.

phone

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

status

string

Requerido

ejemploACCEPTED

The current status of the test device.

created_at

string

Requerido

ejemplo2023-01-01T12:00:00Z

The date and time when the test device was created.

carriers

object

string

Requerido

ejemploatt-us

The id of the carrier.

launch_state

string

ejemploLAUNCH_STATE_UNLAUNCHED

The launch state of the carrier.

verification_details

object

status

string

ejemploVERIFICATION_STATE_UNVERIFIED

The verification status of the RCS Agent.

launch_submitted_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent launch was submitted.

Ejemplo Respuesta

Partially Update Agent (Deprecated)

Partially update an existing RCS Agent. Deprecated, please use the v2 endpoint instead.

patchhttps://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Cuerpo de la solicitud
Tipo de contenido
application/json

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created RCS Agent.

state

string

ejemploDRAFT

The current state of the created RCS Agent.

application_settings

object

application_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the Vonage application with which to associate this agent.

basic_info

object

Requerido

brand_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploExample Co

The unique display name of the RCS Agent.

sender_id

string

Requerido

ejemploExampleCo-RCSAgentv1-1

hosting_region

string

Requerido

ejemploNORTH_AMERICA

The geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Specifies the intended use of the RCS Agent. This cannot be changed after creation.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Specifies the billing category of the RCS Agent.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

notes

string

ejemploThis agent is used for transactional messages only.

Additional notes or comments about the RCS Agent.

DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.

carrier_requirements

object

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

ejemplo

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.

urls

array

media_type

string

Requerido

ejemploimage

The media type of the agent preview.

Debe ser uno de:imagevideo

url

string(uri)

ejemplohttps://www.example.com/rcs-agent-preview.jpg

The URL to the agent preview.

points_of_contact

array

Requerido

A list of points of contact for the RCS Agent.

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

job_title

string

Requerido

Max200

ejemploTechnical Support

The job title of the point of contact.

traffic_estimates

object

Requerido

Traffic estimates for the RCS Agent.

average_global_traffic

string

Requerido

ejemploTHOUSAND

Estimated global traffic.

Debe ser uno de:THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MORE

average_message_rate_per_user

string

Requerido

ejemploONCE_PER_MONTH

Estimated message rate per user.

Debe ser uno de:ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAY

users_targeted

string

Requerido

ejemploHUNDRED

Estimated number of users targeted.

Debe ser uno de:HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE

user_experience

object

Requerido

interactions_description

string

Requerido

Max10000

ejemplo

This 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.

optin_description

string

Requerido

Max10000

ejemplo

This 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.

optout_description

string

Requerido

Max10000

ejemplo

Customers 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.

trigger_description

string

Requerido

Max10000

ejemplo

This 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.

visual_design

object

brand_color

string

Requerido

ejemplo#8860CD

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

array

Requerido

address

string

Requerido

ejemplosupport@example.com

The contact email address for the RCS Agent.

label

string

Max25

ejemploCustomer Support

A label for the email address.

phone

array

Requerido

number

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

label

string

Max25

ejemploCustomer Support

A label for the phone number.

tagline

string

Requerido

Max100

ejemploYour trusted partner in messaging.

A short phrase that represents the RCS Agent.

website

array

Requerido

url

string(uri)

Requerido

ejemplohttps://example.com

label

string

Max25

ejemploCompany Website

A label for the website URL.

logo_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkz

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.

banner_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqb

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.

privacy_policy

string(uri)

ejemplohttps://www.example.com/privacy-policy

The publicly accessible URL of the privacy policy for the RCS Agent.

terms_of_service

string(uri)

ejemplohttps://www.example.com/terms-of-service

The publicly accessible URL of the terms of service for the RCS Agent.

representative

object

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

created_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was created.

updated_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was last updated.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created RCS Agent.

state

string

ejemploDRAFT

The current state of the created RCS Agent.

application_settings

object

application_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the Vonage application with which to associate this agent.

basic_info

object

Requerido

brand_id

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the RCS Brand.

display_name

string

Requerido

ejemploExample Co

The unique display name of the RCS Agent.

sender_id

string

Requerido

ejemploExampleCo-RCSAgentv1-1

hosting_region

string

Requerido

ejemploNORTH_AMERICA

The geographic location where your RCS business messaging service will be hosted and operated. This can affect data residency and compliance requirements.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Specifies the intended use of the RCS Agent. This cannot be changed after creation.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Specifies the billing category of the RCS Agent.

Debe ser uno de:CONVERSATIONALNON_CONVERSATIONAL

notes

string

ejemploThis agent is used for transactional messages only.

Additional notes or comments about the RCS Agent.

DEPRECATED This parameter is deprecated and will be removed in future. It can still be included in the request for backward compatibility, but it will not have any effect on the RCS Agent.

carrier_requirements

object

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

ejemplo

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.

urls

array

media_type

string

Requerido

ejemploimage

The media type of the agent preview.

Debe ser uno de:imagevideo

url

string(uri)

ejemplohttps://www.example.com/rcs-agent-preview.jpg

The URL to the agent preview.

points_of_contact

array

Requerido

A list of points of contact for the RCS Agent.

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

job_title

string

Requerido

Max200

ejemploTechnical Support

The job title of the point of contact.

traffic_estimates

object

Requerido

Traffic estimates for the RCS Agent.

average_global_traffic

string

Requerido

ejemploTHOUSAND

Estimated global traffic.

Debe ser uno de:THOUSANDTEN_THOUSANDFIFTY_THOUSANDHUNDRED_THOUSANDMILLIONMILLION_AND_MORE

average_message_rate_per_user

string

Requerido

ejemploONCE_PER_MONTH

Estimated message rate per user.

Debe ser uno de:ONCE_PER_MONTH2_4_TIMES_PER_MONTHONCE_PER_WEEK2_6_TIMES_PER_WEEKDAILYMULTIPLE_TIMES_PER_DAY

users_targeted

string

Requerido

ejemploHUNDRED

Estimated number of users targeted.

Debe ser uno de:HUNDREDTHOUSANDTEN_THOUSANDHUNDRED_THOUSANDHALF_MILLIONMILLIONMILLION_AND_MORE

user_experience

object

Requerido

interactions_description

string

Requerido

Max10000

ejemplo

This 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.

optin_description

string

Requerido

Max10000

ejemplo

This 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.

optout_description

string

Requerido

Max10000

ejemplo

Customers 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.

trigger_description

string

Requerido

Max10000

ejemplo

This 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.

visual_design

object

brand_color

string

Requerido

ejemplo#8860CD

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

array

Requerido

address

string

Requerido

ejemplosupport@example.com

The contact email address for the RCS Agent.

label

string

Max25

ejemploCustomer Support

A label for the email address.

phone

array

Requerido

number

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

label

string

Max25

ejemploCustomer Support

A label for the phone number.

tagline

string

Requerido

Max100

ejemploYour trusted partner in messaging.

A short phrase that represents the RCS Agent.

website

array

Requerido

url

string(uri)

Requerido

ejemplohttps://example.com

label

string

Max25

ejemploCompany Website

A label for the website URL.

logo_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy6ycz7BnqOi4WKZlOmpkz

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The logo image is not modifiable after agent verification.

banner_image

string(uri)

Requerido

ejemplohttps://agent-logos.storage.googleapis.com/_/mbsy64um0BwndPRK8ECPyeqb

image/png
image/jpeg
image/jpg

Any image file not meeting the requirements will result in an error response. The banner image is not modifiable after agent verification.

privacy_policy

string(uri)

ejemplohttps://www.example.com/privacy-policy

The publicly accessible URL of the privacy policy for the RCS Agent.

terms_of_service

string(uri)

ejemplohttps://www.example.com/terms-of-service

The publicly accessible URL of the terms of service for the RCS Agent.

representative

object

first_name

string

Requerido

Max200

ejemploJohn

The first name of the representative for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the representative for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the representative.

brand_website

string(uri)

ejemplohttps://www.example.com

The website URL of the brand represented by the RCS Agent.

created_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was created.

updated_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent was last updated.

test_devices

array

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The id of the test device.

phone

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

status

string

Requerido

ejemploACCEPTED

The current status of the test device.

created_at

string

Requerido

ejemplo2023-01-01T12:00:00Z

The date and time when the test device was created.

carriers

object

string

Requerido

ejemploatt-us

The id of the carrier.

launch_state

string

ejemploLAUNCH_STATE_UNLAUNCHED

The launch state of the carrier.

verification_details

object

status

string

ejemploVERIFICATION_STATE_UNVERIFIED

The verification status of the RCS Agent.

launch_submitted_at

string

ejemplo2023-01-01T12:00:00Z

The date and time when the RCS Agent launch was submitted.

Ejemplo Respuesta

Get Carriers (Deprecated)

Retrieve a list of available carriers for RCS. Deprecated, please use the v2 endpoint instead.

gethttps://api.nexmo.com/v1/channel-manager/rcs/metadata/carriers

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

carriers

array

Requerido

A list of available carriers for RCS.

string

ejemploverizon-us

A unique identifier for the carrier.

carrier

string

ejemploVerizon

The name of the carrier.

country_letter_code

string

ejemploUS

Code for the country where the carrier operates.

Ejemplo Respuesta

Add Carriers to Agent (Deprecated)

Add carriers to an existing RCS Agent. Deprecated, please use the v2 endpoint instead.

posthttps://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/carriers

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Cuerpo de la solicitud
Tipo de contenido
application/json

carriers

array

Requerido

An array of Carrier IDs to add to the RCS Agent.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Accepted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

message

string

Requerido

ejemploCarriers accepted for processing

Ejemplo Respuesta

Add Test Devices to Agent (Deprecated)

Add test devices to an existing RCS Agent. Deprecated, please use the v2 endpoint instead.

posthttps://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Cuerpo de la solicitud
Tipo de contenido
application/json

phone

string

Requerido

ejemplo+14155552671

The phone number to add to the RCS Agent in E.164 format.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Accepted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

The unique ID of the created test device.

phone

string(e164)

Requerido

ejemplo447700900001

E.164 formatted phone number without + prefix

created_at

string

Requerido

ejemplo2023-01-01T12:00:00Z

The date and time when the test device was created.

status

string

Requerido

ejemploACCEPTED

The current status of the test device.

Ejemplo Respuesta

Remove Test Device from Agent (Deprecated)

Remove a test device from an existing RCS Agent. Deprecated, please use the v2 endpoint instead.

deletehttps://api.nexmo.com/v1/channel-manager/rcs/agents/:agent_id/test-devices/:test_device_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

test_device_id

string

Requerido

ejemplo019809ba-a274-7bd2-aea0-f1f70f2210dc

Test Device Id

Respuestas

No Content - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

List Agents

Retrieve a list of RCS Agents.

gethttps://api.nexmo.com/v2/channel-manager/rcs/agents

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

brand_id

string(uuid)

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

The id of an RCS Brand to filter by.

state

string

ejemploDRAFT

The state of the RCS Agent to filter by. Can be specified multiple times for multiple values.

Debe ser uno de:DRAFTCREATEDPENDINGLAUNCHEDREJECTEDUNLAUNCHED

agent_purpose

string

ejemploTRANSACTIONAL

The agent_purpose of the RCS Agent to filter by. Can be specified multiple times.

Debe ser uno de:PROMOTIONALTRANSACTIONALOTPMULTI_USE

billing_category

string

ejemploCONVERSATIONAL

The billing_category of the RCS Agent to filter by. Can be specified multiple times.

Debe ser uno de:SINGLE_MESSAGEBASIC_MESSAGECONVERSATIONALNON_CONVERSATIONAL

hosting_region

string

ejemploNORTH_AMERICA

The hosting_region of the RCS Agent to filter by. Can be specified multiple times.

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

page

integer

Min1

Por defecto1

ejemplo1

Page number to retrieve

page_size

integer

Min1

Por defecto10

ejemplo20

Number of items to return per page

order

string

The order.

Debe ser uno de:ascdesc

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

page

integer

Requerido

Min1

Por defecto1

ejemplo1

The current page

page_size

integer

Requerido

Min1

Por defecto10

ejemplo20

The size of the page

total_items

integer

Requerido

ejemplo871

The total number of items in the resource list

total_pages

integer

Requerido

Min1

ejemplo42

Total number of pages

_embedded

object

Requerido

agents

array

Requerido

A list of RCS Agents.

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique agent identifier

state

string

ejemploDRAFT

Current state of the agent

Debe ser uno de:DRAFTCREATEDPENDINGLAUNCHEDREJECTEDUNLAUNCHED

basic_info

object

Requerido

display_name

string

Requerido

Max40

ejemploAcme Bank

Display name of the RCS agent shown to end users

sender_id

string

Requerido

Max50

ejemploacme-bank

Unique sender identifier for the agent

hosting_region

string

Requerido

ejemploEUROPE

Region where the agent is hosted

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Intended use case of the agent

Debe ser uno de:TRANSACTIONALPROMOTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Billing category determining how messages are charged

Debe ser uno de:BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALNON_CONVERSATIONAL

brand_id

string(uuid)

Requerido

Max100

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Identifier of the brand this agent belongs to

account_manager_email

string

ejemplomanager@vonage.com

Vonage account manager email address

reseller_email

string

ejemploreseller@partner.com

Reseller email address, in case the agent is created by a reseller party

visual_design

object

tagline

string

Requerido

Max100

ejemploYour trusted banking assistant

Short tagline describing the agent or brand

brand_color

string

Requerido

ejemplo#FF5733

Brand color in hex format, used for button text and UI elements above the agent phone number. Must meet a minimum contrast ratio of 4.5:1 against white (WCAG 2.0). See the support article

logo_image

string

ejemplohttps://cdn.example.com/logo.png

URL of the agent logo image. Shown as a circular avatar next to messages. Requirements: JPEG or PNG, 224x224 px, max 50 KB. See the support article

banner_image

string

ejemplohttps://cdn.example.com/banner.png

URL of the agent banner image. Displayed as a header when users view the agent business info. Requirements: JPEG, 1440x448 px, max 200 KB. See the support article

phone

array

Requerido

List of phone contact numbers (1-3)

number

string

Requerido

ejemplo+12025551234

Phone number in E.164 format

label

string

Max25

ejemploCustomer Support

Display label for this phone number

array

Requerido

List of email contact addresses (1-3)

address

string

Requerido

Min1

ejemplosupport@example.com

Email address

label

string

Max25

ejemploCustomer Support

Display label for this email address

website

array

Requerido

List of website links (1-3)

url

string

Requerido

ejemplohttps://www.example.com

Website URL

label

string

Max25

ejemploOfficial Website

Display label for this website

privacy_policy

string

ejemplohttps://www.example.com/privacy

URL of the privacy policy

terms_of_service

string

ejemplohttps://www.example.com/terms

URL of the terms of service

application_settings

object

application_id

string

Requerido

ejemploa1b2c3d4-e5f6-7890-abcd-ef1234567890

Vonage application ID to associate with this agent

test_devices

array

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique test device identifier

phone

string

Requerido

ejemplo+12025551234

Phone number of the test device in E.164 format

created_at

string

Requerido

Date and time when the test device was added

status

string

Requerido

ejemploACTIVE

Status of the test device registration

representative

object

first_name

string

Requerido

Max200

ejemploJane

First name of the authorized representative

last_name

string

Requerido

Max200

ejemploDoe

Last name of the authorized representative

title

string

Max200

ejemploHead of Messaging

Job title of the authorized representative

string

Requerido

ejemplojane.doe@example.com

Email address of the authorized representative

brand_website

string

ejemplohttps://www.example.com

Brand website URL

phone

string

ejemplo+12025551234

Phone number in E.164 format

carrier_requirements

object

version

string

Requerido

ejemplov2

Carrier requirements schema version

points_of_contact

array

first_name

string

Requerido

Max200

ejemploJohn

The first name of the point of contact for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the point of contact for the RCS Agent.

job_title

string

Requerido

Max200

ejemploHead of Messaging

The job title of the point of contact for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the point of contact for the RCS Agent.

phone

string

ejemplo+12025551234

The phone number of the point of contact for the RCS Agent.

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

Max10000

ejemploVisit https://example.com/rcs-agent and follow the onboarding flow.

Instructions for reviewers on how to access and test the agent

urls

array

List of media URLs showcasing the agent (up to 10)

media_type

string

Requerido

ejemploimage

Media type of the preview asset

Debe ser uno de:imagevideo

url

string

Requerido

ejemplohttps://cdn.example.com/preview.png

URL of the preview asset

rcs_agent_discovery_methods

object

selection

array

Requerido

Methods through which users discover the RCS agent

other_input

string

Max500

ejemploPromoted via in-store QR codes

Additional details when OTHER is selected

consent_management

object

Requerido

user_messaging_consent_methods

object

Requerido

selection

array

Requerido

Selected consent methods

other_input

string

Max500

ejemploUsers consent via in-store sign-up forms

Additional details when OTHER is selected

users_opt_in_process

object

Requerido

selection

array

Requerido

Selected opt-in methods

links

array

URLs where users can opt in (up to 10)

first_opt_in_message

string

Requerido

Max1000

ejemploWelcome! You have successfully opted in to receive updates from Acme Bank.

The first message sent to users after opting in

users_opt_out_methods

object

Requerido

selection

array

Requerido

Selected opt-out methods

other_input

string

Max500

ejemploUsers can opt out via the account settings page

Additional details when OTHER is selected

opt_out_processing_time

object

Requerido

selection

string

Requerido

ejemploWITHIN_5_MINUTES

How quickly opt-out requests are processed

Debe ser uno de:WITHIN_5_MINUTESWITHIN_24_HOURSOTHER

other_input

string

Max500

ejemploProcessed within 2 business days

Additional details when OTHER is selected

opt_out_confirmation_message

object

Requerido

selection

string

Requerido

ejemploSUCCESSFULLY_UNSUBSCRIBED

Confirmation message template sent after opt-out

Debe ser uno de:SUCCESSFULLY_UNSUBSCRIBEDWONT_RECEIVE_FURTHER_MESSAGESOPT_OUT_REQUEST_PROCESSEDREPLY_START_TO_RESUBSCRIBEOPT_OUT_CONFIRMEDOTHER

other_input

string

Max500

ejemploYou have been unsubscribed. Contact support@example.com to resubscribe.

Additional details when OTHER is selected

cta_language

string

Min1

Max2000

ejemploReply YES to receive exclusive offers from Acme Bank.

Call-to-action language used in consent flows

engagement_flows

object

Requerido

agent_description

string

Requerido

Max5000

ejemploAcme Bank RCS agent helps customers check balances, receive transaction alerts, and manage payments.

Description of what the agent does and how it engages with users

reasons_messages_sent

object

Requerido

Reasons why messages are sent to users

selection

array

Requerido

Selected reasons for sending messages

other_input

string

Max500

ejemploSending loyalty program milestone notifications

Additional details when OTHER is selected

monthly_user_message_count

string

Requerido

ejemploTHREE_FIVE_MESSAGES

Estimated number of messages sent to each user per month

Debe ser uno de:ONE_TWO_MESSAGESTHREE_FIVE_MESSAGESSIX_TEN_MESSAGESELEVEN_TWENTY_MESSAGESMORE_THAN_TWENTY_ONE_MESSAGES

rcs_user_interaction_types

object

Requerido

Types of interactions users have with the agent

selection

array

Requerido

Selected types of RCS user interactions

other_input

string

Max500

ejemploUsers interact via custom carousels

Additional details when OTHER is selected

help_interaction

string

Min1

Max2000

ejemploReply HELP for assistance or visit https://www.example.com/support

How the agent responds to HELP messages from users

message_samples

array

Sample messages the agent will send to users (3-10 samples required)

message_type

string

ejemploRICH_MEDIA

Type of RCS messages the agent sends. Use RICH_TEXT or RICH_MEDIA for US carriers; BASIC or SINGLE for non-US carriers.

Debe ser uno de:RICH_TEXTRICH_MEDIABASICSINGLE

agent_summary

object

program_summary

string

Min1

Max2000

ejemploAcme Bank sends transactional alerts and OTP messages to account holders who have opted in.

Summary of the agent messaging program and its intended use

current_traffic

object

organic_website_traffic

object

Current organic website traffic range

min

integer(int64)

max

integer(int64)

existing_shortcode_traffic

boolean

ejemplotrue

Whether the brand currently uses a shortcode for messaging

shortcode_monthly_traffic

object

Monthly traffic volume range for the existing shortcode

min

integer(int64)

max

integer(int64)

shortcode

string

Max50

ejemplo12345

Existing shortcode number

carriers

array

string

Requerido

ejemplogoogle-us-att

Carrier identifier

launch_state

string

Current launch state for this carrier

update_time

string

Date and time of the last status update

launch_submitted_at

string

Date and time when the launch was submitted for this carrier

comment

string

Comment or reason associated with the current launch state

verification_details

object

status

string

ejemploVERIFICATION_STATE_VERIFIED

Verification status of the agent

Debe ser uno de:VERIFICATION_STATE_UNSPECIFIEDVERIFICATION_STATE_UNVERIFIEDVERIFICATION_STATE_PENDINGVERIFICATION_STATE_VERIFIED

brand_details

object

organization_name

string

Requerido

Max255

legal_form

string

Requerido

Max50

stock_symbol

string

Max12

legal_entity_type

string

Requerido

Max50

country_of_registration

string

Requerido

Min2

Max2

federal_tax_id

string

Max50

business_website_url

string

Requerido

Max255

address_line1

string

Requerido

Max255

address_line2

string

Max255

city

string

Requerido

Max100

state_or_province

string

Requerido

Max100

zip_or_post_code

string

Requerido

Max15

launch_submitted_at

string

Date and time when the agent launch was submitted

created_at

string

Date and time when the agent was created

updated_at

string

Date and time when the agent was last updated

_links

object

Requerido

HAL links for page-based paginated collections

self

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

first

object

Requerido

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

last

object

A single HAL link object

href

string

Requerido

ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

Create Agent

Create a new RCS Agent.

posthttps://api.nexmo.com/v2/channel-manager/rcs/agents

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

basic_info

object

Requerido

display_name

string

Requerido

Max40

ejemploAcme Bank

Display name of the RCS agent shown to end users

sender_id

string

Requerido

Max50

ejemploacme-bank

Unique sender identifier for the agent

hosting_region

string

Requerido

ejemploEUROPE

Region where the agent is hosted

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Intended use case of the agent

Debe ser uno de:TRANSACTIONALPROMOTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Billing category determining how messages are charged

Debe ser uno de:BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALNON_CONVERSATIONAL

brand_id

string(uuid)

Requerido

Max100

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Identifier of the brand this agent belongs to

account_manager_email

string

ejemplomanager@vonage.com

Vonage account manager email address

reseller_email

string

ejemploreseller@partner.com

Reseller email address, in case the agent is created by a reseller party

visual_design

object

Requerido

tagline

string

Requerido

Max100

ejemploYour trusted banking assistant

Short tagline describing the agent or brand

brand_color

string

Requerido

ejemplo#FF5733

Brand color in hex format, used for button text and UI elements above the agent phone number. Must meet a minimum contrast ratio of 4.5:1 against white (WCAG 2.0). See the support article

logo_image

string

ejemplohttps://cdn.example.com/logo.png

URL of the agent logo image. Shown as a circular avatar next to messages. Requirements: JPEG or PNG, 224x224 px, max 50 KB. See the support article

banner_image

string

ejemplohttps://cdn.example.com/banner.png

URL of the agent banner image. Displayed as a header when users view the agent business info. Requirements: JPEG, 1440x448 px, max 200 KB. See the support article

phone

array

Requerido

List of phone contact numbers (1-3)

number

string

Requerido

ejemplo+12025551234

Phone number in E.164 format

label

string

Max25

ejemploCustomer Support

Display label for this phone number

array

Requerido

List of email contact addresses (1-3)

address

string

Requerido

Min1

ejemplosupport@example.com

Email address

label

string

Max25

ejemploCustomer Support

Display label for this email address

website

array

Requerido

List of website links (1-3)

url

string

Requerido

ejemplohttps://www.example.com

Website URL

label

string

Max25

ejemploOfficial Website

Display label for this website

privacy_policy

string

ejemplohttps://www.example.com/privacy

URL of the privacy policy

terms_of_service

string

ejemplohttps://www.example.com/terms

URL of the terms of service

application_settings

object

Requerido

application_id

string

Requerido

ejemploa1b2c3d4-e5f6-7890-abcd-ef1234567890

Vonage application ID to associate with this agent

representative

object

first_name

string

Requerido

Max200

ejemploJane

First name of the authorized representative

last_name

string

Requerido

Max200

ejemploDoe

Last name of the authorized representative

title

string

Max200

ejemploHead of Messaging

Job title of the authorized representative

string

Requerido

ejemplojane.doe@example.com

Email address of the authorized representative

brand_website

string

ejemplohttps://www.example.com

Brand website URL

phone

string

ejemplo+12025551234

Phone number in E.164 format

carrier_requirements

object

version

string

Requerido

ejemplov2

Carrier requirements schema version

points_of_contact

array

first_name

string

Requerido

Max200

ejemploJohn

The first name of the point of contact for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the point of contact for the RCS Agent.

job_title

string

Requerido

Max200

ejemploHead of Messaging

The job title of the point of contact for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the point of contact for the RCS Agent.

phone

string

ejemplo+12025551234

The phone number of the point of contact for the RCS Agent.

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

Max10000

ejemploVisit https://example.com/rcs-agent and follow the onboarding flow.

Instructions for reviewers on how to access and test the agent

urls

array

List of media URLs showcasing the agent (up to 10)

media_type

string

Requerido

ejemploimage

Media type of the preview asset

Debe ser uno de:imagevideo

url

string

Requerido

ejemplohttps://cdn.example.com/preview.png

URL of the preview asset

rcs_agent_discovery_methods

object

selection

array

Requerido

Methods through which users discover the RCS agent

other_input

string

Max500

ejemploPromoted via in-store QR codes

Additional details when OTHER is selected

consent_management

object

Requerido

user_messaging_consent_methods

object

Requerido

selection

array

Requerido

Selected consent methods

other_input

string

Max500

ejemploUsers consent via in-store sign-up forms

Additional details when OTHER is selected

users_opt_in_process

object

Requerido

selection

array

Requerido

Selected opt-in methods

links

array

URLs where users can opt in (up to 10)

first_opt_in_message

string

Requerido

Max1000

ejemploWelcome! You have successfully opted in to receive updates from Acme Bank.

The first message sent to users after opting in

users_opt_out_methods

object

Requerido

selection

array

Requerido

Selected opt-out methods

other_input

string

Max500

ejemploUsers can opt out via the account settings page

Additional details when OTHER is selected

opt_out_processing_time

object

Requerido

selection

string

Requerido

ejemploWITHIN_5_MINUTES

How quickly opt-out requests are processed

Debe ser uno de:WITHIN_5_MINUTESWITHIN_24_HOURSOTHER

other_input

string

Max500

ejemploProcessed within 2 business days

Additional details when OTHER is selected

opt_out_confirmation_message

object

Requerido

selection

string

Requerido

ejemploSUCCESSFULLY_UNSUBSCRIBED

Confirmation message template sent after opt-out

Debe ser uno de:SUCCESSFULLY_UNSUBSCRIBEDWONT_RECEIVE_FURTHER_MESSAGESOPT_OUT_REQUEST_PROCESSEDREPLY_START_TO_RESUBSCRIBEOPT_OUT_CONFIRMEDOTHER

other_input

string

Max500

ejemploYou have been unsubscribed. Contact support@example.com to resubscribe.

Additional details when OTHER is selected

cta_language

string

Min1

Max2000

ejemploReply YES to receive exclusive offers from Acme Bank.

Call-to-action language used in consent flows

engagement_flows

object

Requerido

agent_description

string

Requerido

Max5000

ejemploAcme Bank RCS agent helps customers check balances, receive transaction alerts, and manage payments.

Description of what the agent does and how it engages with users

reasons_messages_sent

object

Requerido

Reasons why messages are sent to users

selection

array

Requerido

Selected reasons for sending messages

other_input

string

Max500

ejemploSending loyalty program milestone notifications

Additional details when OTHER is selected

monthly_user_message_count

string

Requerido

ejemploTHREE_FIVE_MESSAGES

Estimated number of messages sent to each user per month

Debe ser uno de:ONE_TWO_MESSAGESTHREE_FIVE_MESSAGESSIX_TEN_MESSAGESELEVEN_TWENTY_MESSAGESMORE_THAN_TWENTY_ONE_MESSAGES

rcs_user_interaction_types

object

Requerido

Types of interactions users have with the agent

selection

array

Requerido

Selected types of RCS user interactions

other_input

string

Max500

ejemploUsers interact via custom carousels

Additional details when OTHER is selected

help_interaction

string

Min1

Max2000

ejemploReply HELP for assistance or visit https://www.example.com/support

How the agent responds to HELP messages from users

message_samples

array

Sample messages the agent will send to users (3-10 samples required)

message_type

string

ejemploRICH_MEDIA

Type of RCS messages the agent sends. Use RICH_TEXT or RICH_MEDIA for US carriers; BASIC or SINGLE for non-US carriers.

Debe ser uno de:RICH_TEXTRICH_MEDIABASICSINGLE

agent_summary

object

program_summary

string

Min1

Max2000

ejemploAcme Bank sends transactional alerts and OTP messages to account holders who have opted in.

Summary of the agent messaging program and its intended use

current_traffic

object

organic_website_traffic

object

Current organic website traffic range

min

integer(int64)

max

integer(int64)

existing_shortcode_traffic

boolean

ejemplotrue

Whether the brand currently uses a shortcode for messaging

shortcode_monthly_traffic

object

Monthly traffic volume range for the existing shortcode

min

integer(int64)

max

integer(int64)

shortcode

string

Max50

ejemplo12345

Existing shortcode number

carriers

array

Requerido

List of carrier identifiers to launch the agent on. Available carrier IDs can be retrieved from the /v2/channel-manager/rcs/metadata/carriers endpoint.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Created

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique agent identifier

state

string

ejemploDRAFT

Current state of the agent

Debe ser uno de:DRAFTCREATEDPENDINGLAUNCHEDREJECTEDUNLAUNCHED

basic_info

object

Requerido

display_name

string

Requerido

Max40

ejemploAcme Bank

Display name of the RCS agent shown to end users

sender_id

string

Requerido

Max50

ejemploacme-bank

Unique sender identifier for the agent

hosting_region

string

Requerido

ejemploEUROPE

Region where the agent is hosted

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Intended use case of the agent

Debe ser uno de:TRANSACTIONALPROMOTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Billing category determining how messages are charged

Debe ser uno de:BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALNON_CONVERSATIONAL

brand_id

string(uuid)

Requerido

Max100

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Identifier of the brand this agent belongs to

account_manager_email

string

ejemplomanager@vonage.com

Vonage account manager email address

reseller_email

string

ejemploreseller@partner.com

Reseller email address, in case the agent is created by a reseller party

visual_design

object

tagline

string

Requerido

Max100

ejemploYour trusted banking assistant

Short tagline describing the agent or brand

brand_color

string

Requerido

ejemplo#FF5733

Brand color in hex format, used for button text and UI elements above the agent phone number. Must meet a minimum contrast ratio of 4.5:1 against white (WCAG 2.0). See the support article

logo_image

string

ejemplohttps://cdn.example.com/logo.png

URL of the agent logo image. Shown as a circular avatar next to messages. Requirements: JPEG or PNG, 224x224 px, max 50 KB. See the support article

banner_image

string

ejemplohttps://cdn.example.com/banner.png

URL of the agent banner image. Displayed as a header when users view the agent business info. Requirements: JPEG, 1440x448 px, max 200 KB. See the support article

phone

array

Requerido

List of phone contact numbers (1-3)

number

string

Requerido

ejemplo+12025551234

Phone number in E.164 format

label

string

Max25

ejemploCustomer Support

Display label for this phone number

array

Requerido

List of email contact addresses (1-3)

address

string

Requerido

Min1

ejemplosupport@example.com

Email address

label

string

Max25

ejemploCustomer Support

Display label for this email address

website

array

Requerido

List of website links (1-3)

url

string

Requerido

ejemplohttps://www.example.com

Website URL

label

string

Max25

ejemploOfficial Website

Display label for this website

privacy_policy

string

ejemplohttps://www.example.com/privacy

URL of the privacy policy

terms_of_service

string

ejemplohttps://www.example.com/terms

URL of the terms of service

application_settings

object

application_id

string

Requerido

ejemploa1b2c3d4-e5f6-7890-abcd-ef1234567890

Vonage application ID to associate with this agent

test_devices

array

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique test device identifier

phone

string

Requerido

ejemplo+12025551234

Phone number of the test device in E.164 format

created_at

string

Requerido

Date and time when the test device was added

status

string

Requerido

ejemploACTIVE

Status of the test device registration

representative

object

first_name

string

Requerido

Max200

ejemploJane

First name of the authorized representative

last_name

string

Requerido

Max200

ejemploDoe

Last name of the authorized representative

title

string

Max200

ejemploHead of Messaging

Job title of the authorized representative

string

Requerido

ejemplojane.doe@example.com

Email address of the authorized representative

brand_website

string

ejemplohttps://www.example.com

Brand website URL

phone

string

ejemplo+12025551234

Phone number in E.164 format

carrier_requirements

object

version

string

Requerido

ejemplov2

Carrier requirements schema version

points_of_contact

array

first_name

string

Requerido

Max200

ejemploJohn

The first name of the point of contact for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the point of contact for the RCS Agent.

job_title

string

Requerido

Max200

ejemploHead of Messaging

The job title of the point of contact for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the point of contact for the RCS Agent.

phone

string

ejemplo+12025551234

The phone number of the point of contact for the RCS Agent.

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

Max10000

ejemploVisit https://example.com/rcs-agent and follow the onboarding flow.

Instructions for reviewers on how to access and test the agent

urls

array

List of media URLs showcasing the agent (up to 10)

media_type

string

Requerido

ejemploimage

Media type of the preview asset

Debe ser uno de:imagevideo

url

string

Requerido

ejemplohttps://cdn.example.com/preview.png

URL of the preview asset

rcs_agent_discovery_methods

object

selection

array

Requerido

Methods through which users discover the RCS agent

other_input

string

Max500

ejemploPromoted via in-store QR codes

Additional details when OTHER is selected

consent_management

object

Requerido

user_messaging_consent_methods

object

Requerido

selection

array

Requerido

Selected consent methods

other_input

string

Max500

ejemploUsers consent via in-store sign-up forms

Additional details when OTHER is selected

users_opt_in_process

object

Requerido

selection

array

Requerido

Selected opt-in methods

links

array

URLs where users can opt in (up to 10)

first_opt_in_message

string

Requerido

Max1000

ejemploWelcome! You have successfully opted in to receive updates from Acme Bank.

The first message sent to users after opting in

users_opt_out_methods

object

Requerido

selection

array

Requerido

Selected opt-out methods

other_input

string

Max500

ejemploUsers can opt out via the account settings page

Additional details when OTHER is selected

opt_out_processing_time

object

Requerido

selection

string

Requerido

ejemploWITHIN_5_MINUTES

How quickly opt-out requests are processed

Debe ser uno de:WITHIN_5_MINUTESWITHIN_24_HOURSOTHER

other_input

string

Max500

ejemploProcessed within 2 business days

Additional details when OTHER is selected

opt_out_confirmation_message

object

Requerido

selection

string

Requerido

ejemploSUCCESSFULLY_UNSUBSCRIBED

Confirmation message template sent after opt-out

Debe ser uno de:SUCCESSFULLY_UNSUBSCRIBEDWONT_RECEIVE_FURTHER_MESSAGESOPT_OUT_REQUEST_PROCESSEDREPLY_START_TO_RESUBSCRIBEOPT_OUT_CONFIRMEDOTHER

other_input

string

Max500

ejemploYou have been unsubscribed. Contact support@example.com to resubscribe.

Additional details when OTHER is selected

cta_language

string

Min1

Max2000

ejemploReply YES to receive exclusive offers from Acme Bank.

Call-to-action language used in consent flows

engagement_flows

object

Requerido

agent_description

string

Requerido

Max5000

ejemploAcme Bank RCS agent helps customers check balances, receive transaction alerts, and manage payments.

Description of what the agent does and how it engages with users

reasons_messages_sent

object

Requerido

Reasons why messages are sent to users

selection

array

Requerido

Selected reasons for sending messages

other_input

string

Max500

ejemploSending loyalty program milestone notifications

Additional details when OTHER is selected

monthly_user_message_count

string

Requerido

ejemploTHREE_FIVE_MESSAGES

Estimated number of messages sent to each user per month

Debe ser uno de:ONE_TWO_MESSAGESTHREE_FIVE_MESSAGESSIX_TEN_MESSAGESELEVEN_TWENTY_MESSAGESMORE_THAN_TWENTY_ONE_MESSAGES

rcs_user_interaction_types

object

Requerido

Types of interactions users have with the agent

selection

array

Requerido

Selected types of RCS user interactions

other_input

string

Max500

ejemploUsers interact via custom carousels

Additional details when OTHER is selected

help_interaction

string

Min1

Max2000

ejemploReply HELP for assistance or visit https://www.example.com/support

How the agent responds to HELP messages from users

message_samples

array

Sample messages the agent will send to users (3-10 samples required)

message_type

string

ejemploRICH_MEDIA

Type of RCS messages the agent sends. Use RICH_TEXT or RICH_MEDIA for US carriers; BASIC or SINGLE for non-US carriers.

Debe ser uno de:RICH_TEXTRICH_MEDIABASICSINGLE

agent_summary

object

program_summary

string

Min1

Max2000

ejemploAcme Bank sends transactional alerts and OTP messages to account holders who have opted in.

Summary of the agent messaging program and its intended use

current_traffic

object

organic_website_traffic

object

Current organic website traffic range

min

integer(int64)

max

integer(int64)

existing_shortcode_traffic

boolean

ejemplotrue

Whether the brand currently uses a shortcode for messaging

shortcode_monthly_traffic

object

Monthly traffic volume range for the existing shortcode

min

integer(int64)

max

integer(int64)

shortcode

string

Max50

ejemplo12345

Existing shortcode number

carriers

array

string

Requerido

ejemplogoogle-us-att

Carrier identifier

launch_state

string

Current launch state for this carrier

update_time

string

Date and time of the last status update

launch_submitted_at

string

Date and time when the launch was submitted for this carrier

comment

string

Comment or reason associated with the current launch state

verification_details

object

status

string

ejemploVERIFICATION_STATE_VERIFIED

Verification status of the agent

Debe ser uno de:VERIFICATION_STATE_UNSPECIFIEDVERIFICATION_STATE_UNVERIFIEDVERIFICATION_STATE_PENDINGVERIFICATION_STATE_VERIFIED

brand_details

object

organization_name

string

Requerido

Max255

legal_form

string

Requerido

Max50

stock_symbol

string

Max12

legal_entity_type

string

Requerido

Max50

country_of_registration

string

Requerido

Min2

Max2

federal_tax_id

string

Max50

business_website_url

string

Requerido

Max255

address_line1

string

Requerido

Max255

address_line2

string

Max255

city

string

Requerido

Max100

state_or_province

string

Requerido

Max100

zip_or_post_code

string

Requerido

Max15

launch_submitted_at

string

Date and time when the agent launch was submitted

created_at

string

Date and time when the agent was created

updated_at

string

Date and time when the agent was last updated

Ejemplo Respuesta

Get Agent

Retrieve an existing RCS Agent.

gethttps://api.nexmo.com/v2/channel-manager/rcs/agents/:agent_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique agent identifier

state

string

ejemploDRAFT

Current state of the agent

Debe ser uno de:DRAFTCREATEDPENDINGLAUNCHEDREJECTEDUNLAUNCHED

basic_info

object

Requerido

display_name

string

Requerido

Max40

ejemploAcme Bank

Display name of the RCS agent shown to end users

sender_id

string

Requerido

Max50

ejemploacme-bank

Unique sender identifier for the agent

hosting_region

string

Requerido

ejemploEUROPE

Region where the agent is hosted

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Intended use case of the agent

Debe ser uno de:TRANSACTIONALPROMOTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Billing category determining how messages are charged

Debe ser uno de:BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALNON_CONVERSATIONAL

brand_id

string(uuid)

Requerido

Max100

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Identifier of the brand this agent belongs to

account_manager_email

string

ejemplomanager@vonage.com

Vonage account manager email address

reseller_email

string

ejemploreseller@partner.com

Reseller email address, in case the agent is created by a reseller party

visual_design

object

tagline

string

Requerido

Max100

ejemploYour trusted banking assistant

Short tagline describing the agent or brand

brand_color

string

Requerido

ejemplo#FF5733

Brand color in hex format, used for button text and UI elements above the agent phone number. Must meet a minimum contrast ratio of 4.5:1 against white (WCAG 2.0). See the support article

logo_image

string

ejemplohttps://cdn.example.com/logo.png

URL of the agent logo image. Shown as a circular avatar next to messages. Requirements: JPEG or PNG, 224x224 px, max 50 KB. See the support article

banner_image

string

ejemplohttps://cdn.example.com/banner.png

URL of the agent banner image. Displayed as a header when users view the agent business info. Requirements: JPEG, 1440x448 px, max 200 KB. See the support article

phone

array

Requerido

List of phone contact numbers (1-3)

number

string

Requerido

ejemplo+12025551234

Phone number in E.164 format

label

string

Max25

ejemploCustomer Support

Display label for this phone number

array

Requerido

List of email contact addresses (1-3)

address

string

Requerido

Min1

ejemplosupport@example.com

Email address

label

string

Max25

ejemploCustomer Support

Display label for this email address

website

array

Requerido

List of website links (1-3)

url

string

Requerido

ejemplohttps://www.example.com

Website URL

label

string

Max25

ejemploOfficial Website

Display label for this website

privacy_policy

string

ejemplohttps://www.example.com/privacy

URL of the privacy policy

terms_of_service

string

ejemplohttps://www.example.com/terms

URL of the terms of service

application_settings

object

application_id

string

Requerido

ejemploa1b2c3d4-e5f6-7890-abcd-ef1234567890

Vonage application ID to associate with this agent

test_devices

array

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique test device identifier

phone

string

Requerido

ejemplo+12025551234

Phone number of the test device in E.164 format

created_at

string

Requerido

Date and time when the test device was added

status

string

Requerido

ejemploACTIVE

Status of the test device registration

representative

object

first_name

string

Requerido

Max200

ejemploJane

First name of the authorized representative

last_name

string

Requerido

Max200

ejemploDoe

Last name of the authorized representative

title

string

Max200

ejemploHead of Messaging

Job title of the authorized representative

string

Requerido

ejemplojane.doe@example.com

Email address of the authorized representative

brand_website

string

ejemplohttps://www.example.com

Brand website URL

phone

string

ejemplo+12025551234

Phone number in E.164 format

carrier_requirements

object

version

string

Requerido

ejemplov2

Carrier requirements schema version

points_of_contact

array

first_name

string

Requerido

Max200

ejemploJohn

The first name of the point of contact for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the point of contact for the RCS Agent.

job_title

string

Requerido

Max200

ejemploHead of Messaging

The job title of the point of contact for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the point of contact for the RCS Agent.

phone

string

ejemplo+12025551234

The phone number of the point of contact for the RCS Agent.

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

Max10000

ejemploVisit https://example.com/rcs-agent and follow the onboarding flow.

Instructions for reviewers on how to access and test the agent

urls

array

List of media URLs showcasing the agent (up to 10)

media_type

string

Requerido

ejemploimage

Media type of the preview asset

Debe ser uno de:imagevideo

url

string

Requerido

ejemplohttps://cdn.example.com/preview.png

URL of the preview asset

rcs_agent_discovery_methods

object

selection

array

Requerido

Methods through which users discover the RCS agent

other_input

string

Max500

ejemploPromoted via in-store QR codes

Additional details when OTHER is selected

consent_management

object

Requerido

user_messaging_consent_methods

object

Requerido

selection

array

Requerido

Selected consent methods

other_input

string

Max500

ejemploUsers consent via in-store sign-up forms

Additional details when OTHER is selected

users_opt_in_process

object

Requerido

selection

array

Requerido

Selected opt-in methods

links

array

URLs where users can opt in (up to 10)

first_opt_in_message

string

Requerido

Max1000

ejemploWelcome! You have successfully opted in to receive updates from Acme Bank.

The first message sent to users after opting in

users_opt_out_methods

object

Requerido

selection

array

Requerido

Selected opt-out methods

other_input

string

Max500

ejemploUsers can opt out via the account settings page

Additional details when OTHER is selected

opt_out_processing_time

object

Requerido

selection

string

Requerido

ejemploWITHIN_5_MINUTES

How quickly opt-out requests are processed

Debe ser uno de:WITHIN_5_MINUTESWITHIN_24_HOURSOTHER

other_input

string

Max500

ejemploProcessed within 2 business days

Additional details when OTHER is selected

opt_out_confirmation_message

object

Requerido

selection

string

Requerido

ejemploSUCCESSFULLY_UNSUBSCRIBED

Confirmation message template sent after opt-out

Debe ser uno de:SUCCESSFULLY_UNSUBSCRIBEDWONT_RECEIVE_FURTHER_MESSAGESOPT_OUT_REQUEST_PROCESSEDREPLY_START_TO_RESUBSCRIBEOPT_OUT_CONFIRMEDOTHER

other_input

string

Max500

ejemploYou have been unsubscribed. Contact support@example.com to resubscribe.

Additional details when OTHER is selected

cta_language

string

Min1

Max2000

ejemploReply YES to receive exclusive offers from Acme Bank.

Call-to-action language used in consent flows

engagement_flows

object

Requerido

agent_description

string

Requerido

Max5000

ejemploAcme Bank RCS agent helps customers check balances, receive transaction alerts, and manage payments.

Description of what the agent does and how it engages with users

reasons_messages_sent

object

Requerido

Reasons why messages are sent to users

selection

array

Requerido

Selected reasons for sending messages

other_input

string

Max500

ejemploSending loyalty program milestone notifications

Additional details when OTHER is selected

monthly_user_message_count

string

Requerido

ejemploTHREE_FIVE_MESSAGES

Estimated number of messages sent to each user per month

Debe ser uno de:ONE_TWO_MESSAGESTHREE_FIVE_MESSAGESSIX_TEN_MESSAGESELEVEN_TWENTY_MESSAGESMORE_THAN_TWENTY_ONE_MESSAGES

rcs_user_interaction_types

object

Requerido

Types of interactions users have with the agent

selection

array

Requerido

Selected types of RCS user interactions

other_input

string

Max500

ejemploUsers interact via custom carousels

Additional details when OTHER is selected

help_interaction

string

Min1

Max2000

ejemploReply HELP for assistance or visit https://www.example.com/support

How the agent responds to HELP messages from users

message_samples

array

Sample messages the agent will send to users (3-10 samples required)

message_type

string

ejemploRICH_MEDIA

Type of RCS messages the agent sends. Use RICH_TEXT or RICH_MEDIA for US carriers; BASIC or SINGLE for non-US carriers.

Debe ser uno de:RICH_TEXTRICH_MEDIABASICSINGLE

agent_summary

object

program_summary

string

Min1

Max2000

ejemploAcme Bank sends transactional alerts and OTP messages to account holders who have opted in.

Summary of the agent messaging program and its intended use

current_traffic

object

organic_website_traffic

object

Current organic website traffic range

min

integer(int64)

max

integer(int64)

existing_shortcode_traffic

boolean

ejemplotrue

Whether the brand currently uses a shortcode for messaging

shortcode_monthly_traffic

object

Monthly traffic volume range for the existing shortcode

min

integer(int64)

max

integer(int64)

shortcode

string

Max50

ejemplo12345

Existing shortcode number

carriers

array

string

Requerido

ejemplogoogle-us-att

Carrier identifier

launch_state

string

Current launch state for this carrier

update_time

string

Date and time of the last status update

launch_submitted_at

string

Date and time when the launch was submitted for this carrier

comment

string

Comment or reason associated with the current launch state

verification_details

object

status

string

ejemploVERIFICATION_STATE_VERIFIED

Verification status of the agent

Debe ser uno de:VERIFICATION_STATE_UNSPECIFIEDVERIFICATION_STATE_UNVERIFIEDVERIFICATION_STATE_PENDINGVERIFICATION_STATE_VERIFIED

brand_details

object

organization_name

string

Requerido

Max255

legal_form

string

Requerido

Max50

stock_symbol

string

Max12

legal_entity_type

string

Requerido

Max50

country_of_registration

string

Requerido

Min2

Max2

federal_tax_id

string

Max50

business_website_url

string

Requerido

Max255

address_line1

string

Requerido

Max255

address_line2

string

Max255

city

string

Requerido

Max100

state_or_province

string

Requerido

Max100

zip_or_post_code

string

Requerido

Max15

launch_submitted_at

string

Date and time when the agent launch was submitted

created_at

string

Date and time when the agent was created

updated_at

string

Date and time when the agent was last updated

Ejemplo Respuesta

Update Agent

Fully update an existing RCS Agent.

puthttps://api.nexmo.com/v2/channel-manager/rcs/agents/:agent_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Cuerpo de la solicitud
Tipo de contenido
application/json

basic_info

object

Requerido

display_name

string

Requerido

Max40

ejemploAcme Bank

Display name of the RCS agent shown to end users

sender_id

string

Requerido

Max50

ejemploacme-bank

Unique sender identifier for the agent

hosting_region

string

Requerido

ejemploEUROPE

Region where the agent is hosted

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Intended use case of the agent

Debe ser uno de:TRANSACTIONALPROMOTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Billing category determining how messages are charged

Debe ser uno de:BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALNON_CONVERSATIONAL

brand_id

string(uuid)

Requerido

Max100

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Identifier of the brand this agent belongs to

account_manager_email

string

ejemplomanager@vonage.com

Vonage account manager email address

reseller_email

string

ejemploreseller@partner.com

Reseller email address, in case the agent is created by a reseller party

visual_design

object

Requerido

tagline

string

Requerido

Max100

ejemploYour trusted banking assistant

Short tagline describing the agent or brand

brand_color

string

Requerido

ejemplo#FF5733

Brand color in hex format, used for button text and UI elements above the agent phone number. Must meet a minimum contrast ratio of 4.5:1 against white (WCAG 2.0). See the support article

logo_image

string

ejemplohttps://cdn.example.com/logo.png

URL of the agent logo image. Shown as a circular avatar next to messages. Requirements: JPEG or PNG, 224x224 px, max 50 KB. See the support article

banner_image

string

ejemplohttps://cdn.example.com/banner.png

URL of the agent banner image. Displayed as a header when users view the agent business info. Requirements: JPEG, 1440x448 px, max 200 KB. See the support article

phone

array

Requerido

List of phone contact numbers (1-3)

number

string

Requerido

ejemplo+12025551234

Phone number in E.164 format

label

string

Max25

ejemploCustomer Support

Display label for this phone number

array

Requerido

List of email contact addresses (1-3)

address

string

Requerido

Min1

ejemplosupport@example.com

Email address

label

string

Max25

ejemploCustomer Support

Display label for this email address

website

array

Requerido

List of website links (1-3)

url

string

Requerido

ejemplohttps://www.example.com

Website URL

label

string

Max25

ejemploOfficial Website

Display label for this website

privacy_policy

string

ejemplohttps://www.example.com/privacy

URL of the privacy policy

terms_of_service

string

ejemplohttps://www.example.com/terms

URL of the terms of service

application_settings

object

Requerido

application_id

string

Requerido

ejemploa1b2c3d4-e5f6-7890-abcd-ef1234567890

Vonage application ID to associate with this agent

representative

object

Requerido

first_name

string

Requerido

Max200

ejemploJane

First name of the authorized representative

last_name

string

Requerido

Max200

ejemploDoe

Last name of the authorized representative

title

string

Max200

ejemploHead of Messaging

Job title of the authorized representative

string

Requerido

ejemplojane.doe@example.com

Email address of the authorized representative

brand_website

string

ejemplohttps://www.example.com

Brand website URL

phone

string

ejemplo+12025551234

Phone number in E.164 format

carrier_requirements

object

Requerido

version

string

Requerido

ejemplov2

Carrier requirements schema version

points_of_contact

array

first_name

string

Requerido

Max200

ejemploJohn

The first name of the point of contact for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the point of contact for the RCS Agent.

job_title

string

Requerido

Max200

ejemploHead of Messaging

The job title of the point of contact for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the point of contact for the RCS Agent.

phone

string

ejemplo+12025551234

The phone number of the point of contact for the RCS Agent.

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

Max10000

ejemploVisit https://example.com/rcs-agent and follow the onboarding flow.

Instructions for reviewers on how to access and test the agent

urls

array

List of media URLs showcasing the agent (up to 10)

media_type

string

Requerido

ejemploimage

Media type of the preview asset

Debe ser uno de:imagevideo

url

string

Requerido

ejemplohttps://cdn.example.com/preview.png

URL of the preview asset

rcs_agent_discovery_methods

object

selection

array

Requerido

Methods through which users discover the RCS agent

other_input

string

Max500

ejemploPromoted via in-store QR codes

Additional details when OTHER is selected

consent_management

object

Requerido

user_messaging_consent_methods

object

Requerido

selection

array

Requerido

Selected consent methods

other_input

string

Max500

ejemploUsers consent via in-store sign-up forms

Additional details when OTHER is selected

users_opt_in_process

object

Requerido

selection

array

Requerido

Selected opt-in methods

links

array

URLs where users can opt in (up to 10)

first_opt_in_message

string

Requerido

Max1000

ejemploWelcome! You have successfully opted in to receive updates from Acme Bank.

The first message sent to users after opting in

users_opt_out_methods

object

Requerido

selection

array

Requerido

Selected opt-out methods

other_input

string

Max500

ejemploUsers can opt out via the account settings page

Additional details when OTHER is selected

opt_out_processing_time

object

Requerido

selection

string

Requerido

ejemploWITHIN_5_MINUTES

How quickly opt-out requests are processed

Debe ser uno de:WITHIN_5_MINUTESWITHIN_24_HOURSOTHER

other_input

string

Max500

ejemploProcessed within 2 business days

Additional details when OTHER is selected

opt_out_confirmation_message

object

Requerido

selection

string

Requerido

ejemploSUCCESSFULLY_UNSUBSCRIBED

Confirmation message template sent after opt-out

Debe ser uno de:SUCCESSFULLY_UNSUBSCRIBEDWONT_RECEIVE_FURTHER_MESSAGESOPT_OUT_REQUEST_PROCESSEDREPLY_START_TO_RESUBSCRIBEOPT_OUT_CONFIRMEDOTHER

other_input

string

Max500

ejemploYou have been unsubscribed. Contact support@example.com to resubscribe.

Additional details when OTHER is selected

cta_language

string

Min1

Max2000

ejemploReply YES to receive exclusive offers from Acme Bank.

Call-to-action language used in consent flows

engagement_flows

object

Requerido

agent_description

string

Requerido

Max5000

ejemploAcme Bank RCS agent helps customers check balances, receive transaction alerts, and manage payments.

Description of what the agent does and how it engages with users

reasons_messages_sent

object

Requerido

Reasons why messages are sent to users

selection

array

Requerido

Selected reasons for sending messages

other_input

string

Max500

ejemploSending loyalty program milestone notifications

Additional details when OTHER is selected

monthly_user_message_count

string

Requerido

ejemploTHREE_FIVE_MESSAGES

Estimated number of messages sent to each user per month

Debe ser uno de:ONE_TWO_MESSAGESTHREE_FIVE_MESSAGESSIX_TEN_MESSAGESELEVEN_TWENTY_MESSAGESMORE_THAN_TWENTY_ONE_MESSAGES

rcs_user_interaction_types

object

Requerido

Types of interactions users have with the agent

selection

array

Requerido

Selected types of RCS user interactions

other_input

string

Max500

ejemploUsers interact via custom carousels

Additional details when OTHER is selected

help_interaction

string

Min1

Max2000

ejemploReply HELP for assistance or visit https://www.example.com/support

How the agent responds to HELP messages from users

message_samples

array

Sample messages the agent will send to users (3-10 samples required)

message_type

string

ejemploRICH_MEDIA

Type of RCS messages the agent sends. Use RICH_TEXT or RICH_MEDIA for US carriers; BASIC or SINGLE for non-US carriers.

Debe ser uno de:RICH_TEXTRICH_MEDIABASICSINGLE

agent_summary

object

program_summary

string

Min1

Max2000

ejemploAcme Bank sends transactional alerts and OTP messages to account holders who have opted in.

Summary of the agent messaging program and its intended use

current_traffic

object

organic_website_traffic

object

Current organic website traffic range

min

integer(int64)

max

integer(int64)

existing_shortcode_traffic

boolean

ejemplotrue

Whether the brand currently uses a shortcode for messaging

shortcode_monthly_traffic

object

Monthly traffic volume range for the existing shortcode

min

integer(int64)

max

integer(int64)

shortcode

string

Max50

ejemplo12345

Existing shortcode number

carriers

array

Requerido

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Accepted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique agent identifier

state

string

ejemploDRAFT

Current state of the agent

Debe ser uno de:DRAFTCREATEDPENDINGLAUNCHEDREJECTEDUNLAUNCHED

basic_info

object

Requerido

display_name

string

Requerido

Max40

ejemploAcme Bank

Display name of the RCS agent shown to end users

sender_id

string

Requerido

Max50

ejemploacme-bank

Unique sender identifier for the agent

hosting_region

string

Requerido

ejemploEUROPE

Region where the agent is hosted

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Intended use case of the agent

Debe ser uno de:TRANSACTIONALPROMOTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Billing category determining how messages are charged

Debe ser uno de:BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALNON_CONVERSATIONAL

brand_id

string(uuid)

Requerido

Max100

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Identifier of the brand this agent belongs to

account_manager_email

string

ejemplomanager@vonage.com

Vonage account manager email address

reseller_email

string

ejemploreseller@partner.com

Reseller email address, in case the agent is created by a reseller party

visual_design

object

tagline

string

Requerido

Max100

ejemploYour trusted banking assistant

Short tagline describing the agent or brand

brand_color

string

Requerido

ejemplo#FF5733

Brand color in hex format, used for button text and UI elements above the agent phone number. Must meet a minimum contrast ratio of 4.5:1 against white (WCAG 2.0). See the support article

logo_image

string

ejemplohttps://cdn.example.com/logo.png

URL of the agent logo image. Shown as a circular avatar next to messages. Requirements: JPEG or PNG, 224x224 px, max 50 KB. See the support article

banner_image

string

ejemplohttps://cdn.example.com/banner.png

URL of the agent banner image. Displayed as a header when users view the agent business info. Requirements: JPEG, 1440x448 px, max 200 KB. See the support article

phone

array

Requerido

List of phone contact numbers (1-3)

number

string

Requerido

ejemplo+12025551234

Phone number in E.164 format

label

string

Max25

ejemploCustomer Support

Display label for this phone number

array

Requerido

List of email contact addresses (1-3)

address

string

Requerido

Min1

ejemplosupport@example.com

Email address

label

string

Max25

ejemploCustomer Support

Display label for this email address

website

array

Requerido

List of website links (1-3)

url

string

Requerido

ejemplohttps://www.example.com

Website URL

label

string

Max25

ejemploOfficial Website

Display label for this website

privacy_policy

string

ejemplohttps://www.example.com/privacy

URL of the privacy policy

terms_of_service

string

ejemplohttps://www.example.com/terms

URL of the terms of service

application_settings

object

application_id

string

Requerido

ejemploa1b2c3d4-e5f6-7890-abcd-ef1234567890

Vonage application ID to associate with this agent

test_devices

array

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique test device identifier

phone

string

Requerido

ejemplo+12025551234

Phone number of the test device in E.164 format

created_at

string

Requerido

Date and time when the test device was added

status

string

Requerido

ejemploACTIVE

Status of the test device registration

representative

object

first_name

string

Requerido

Max200

ejemploJane

First name of the authorized representative

last_name

string

Requerido

Max200

ejemploDoe

Last name of the authorized representative

title

string

Max200

ejemploHead of Messaging

Job title of the authorized representative

string

Requerido

ejemplojane.doe@example.com

Email address of the authorized representative

brand_website

string

ejemplohttps://www.example.com

Brand website URL

phone

string

ejemplo+12025551234

Phone number in E.164 format

carrier_requirements

object

version

string

Requerido

ejemplov2

Carrier requirements schema version

points_of_contact

array

first_name

string

Requerido

Max200

ejemploJohn

The first name of the point of contact for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the point of contact for the RCS Agent.

job_title

string

Requerido

Max200

ejemploHead of Messaging

The job title of the point of contact for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the point of contact for the RCS Agent.

phone

string

ejemplo+12025551234

The phone number of the point of contact for the RCS Agent.

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

Max10000

ejemploVisit https://example.com/rcs-agent and follow the onboarding flow.

Instructions for reviewers on how to access and test the agent

urls

array

List of media URLs showcasing the agent (up to 10)

media_type

string

Requerido

ejemploimage

Media type of the preview asset

Debe ser uno de:imagevideo

url

string

Requerido

ejemplohttps://cdn.example.com/preview.png

URL of the preview asset

rcs_agent_discovery_methods

object

selection

array

Requerido

Methods through which users discover the RCS agent

other_input

string

Max500

ejemploPromoted via in-store QR codes

Additional details when OTHER is selected

consent_management

object

Requerido

user_messaging_consent_methods

object

Requerido

selection

array

Requerido

Selected consent methods

other_input

string

Max500

ejemploUsers consent via in-store sign-up forms

Additional details when OTHER is selected

users_opt_in_process

object

Requerido

selection

array

Requerido

Selected opt-in methods

links

array

URLs where users can opt in (up to 10)

first_opt_in_message

string

Requerido

Max1000

ejemploWelcome! You have successfully opted in to receive updates from Acme Bank.

The first message sent to users after opting in

users_opt_out_methods

object

Requerido

selection

array

Requerido

Selected opt-out methods

other_input

string

Max500

ejemploUsers can opt out via the account settings page

Additional details when OTHER is selected

opt_out_processing_time

object

Requerido

selection

string

Requerido

ejemploWITHIN_5_MINUTES

How quickly opt-out requests are processed

Debe ser uno de:WITHIN_5_MINUTESWITHIN_24_HOURSOTHER

other_input

string

Max500

ejemploProcessed within 2 business days

Additional details when OTHER is selected

opt_out_confirmation_message

object

Requerido

selection

string

Requerido

ejemploSUCCESSFULLY_UNSUBSCRIBED

Confirmation message template sent after opt-out

Debe ser uno de:SUCCESSFULLY_UNSUBSCRIBEDWONT_RECEIVE_FURTHER_MESSAGESOPT_OUT_REQUEST_PROCESSEDREPLY_START_TO_RESUBSCRIBEOPT_OUT_CONFIRMEDOTHER

other_input

string

Max500

ejemploYou have been unsubscribed. Contact support@example.com to resubscribe.

Additional details when OTHER is selected

cta_language

string

Min1

Max2000

ejemploReply YES to receive exclusive offers from Acme Bank.

Call-to-action language used in consent flows

engagement_flows

object

Requerido

agent_description

string

Requerido

Max5000

ejemploAcme Bank RCS agent helps customers check balances, receive transaction alerts, and manage payments.

Description of what the agent does and how it engages with users

reasons_messages_sent

object

Requerido

Reasons why messages are sent to users

selection

array

Requerido

Selected reasons for sending messages

other_input

string

Max500

ejemploSending loyalty program milestone notifications

Additional details when OTHER is selected

monthly_user_message_count

string

Requerido

ejemploTHREE_FIVE_MESSAGES

Estimated number of messages sent to each user per month

Debe ser uno de:ONE_TWO_MESSAGESTHREE_FIVE_MESSAGESSIX_TEN_MESSAGESELEVEN_TWENTY_MESSAGESMORE_THAN_TWENTY_ONE_MESSAGES

rcs_user_interaction_types

object

Requerido

Types of interactions users have with the agent

selection

array

Requerido

Selected types of RCS user interactions

other_input

string

Max500

ejemploUsers interact via custom carousels

Additional details when OTHER is selected

help_interaction

string

Min1

Max2000

ejemploReply HELP for assistance or visit https://www.example.com/support

How the agent responds to HELP messages from users

message_samples

array

Sample messages the agent will send to users (3-10 samples required)

message_type

string

ejemploRICH_MEDIA

Type of RCS messages the agent sends. Use RICH_TEXT or RICH_MEDIA for US carriers; BASIC or SINGLE for non-US carriers.

Debe ser uno de:RICH_TEXTRICH_MEDIABASICSINGLE

agent_summary

object

program_summary

string

Min1

Max2000

ejemploAcme Bank sends transactional alerts and OTP messages to account holders who have opted in.

Summary of the agent messaging program and its intended use

current_traffic

object

organic_website_traffic

object

Current organic website traffic range

min

integer(int64)

max

integer(int64)

existing_shortcode_traffic

boolean

ejemplotrue

Whether the brand currently uses a shortcode for messaging

shortcode_monthly_traffic

object

Monthly traffic volume range for the existing shortcode

min

integer(int64)

max

integer(int64)

shortcode

string

Max50

ejemplo12345

Existing shortcode number

carriers

array

string

Requerido

ejemplogoogle-us-att

Carrier identifier

launch_state

string

Current launch state for this carrier

update_time

string

Date and time of the last status update

launch_submitted_at

string

Date and time when the launch was submitted for this carrier

comment

string

Comment or reason associated with the current launch state

verification_details

object

status

string

ejemploVERIFICATION_STATE_VERIFIED

Verification status of the agent

Debe ser uno de:VERIFICATION_STATE_UNSPECIFIEDVERIFICATION_STATE_UNVERIFIEDVERIFICATION_STATE_PENDINGVERIFICATION_STATE_VERIFIED

brand_details

object

organization_name

string

Requerido

Max255

legal_form

string

Requerido

Max50

stock_symbol

string

Max12

legal_entity_type

string

Requerido

Max50

country_of_registration

string

Requerido

Min2

Max2

federal_tax_id

string

Max50

business_website_url

string

Requerido

Max255

address_line1

string

Requerido

Max255

address_line2

string

Max255

city

string

Requerido

Max100

state_or_province

string

Requerido

Max100

zip_or_post_code

string

Requerido

Max15

launch_submitted_at

string

Date and time when the agent launch was submitted

created_at

string

Date and time when the agent was created

updated_at

string

Date and time when the agent was last updated

Ejemplo Respuesta

Partially Update Agent

Partially update an existing RCS Agent.

patchhttps://api.nexmo.com/v2/channel-manager/rcs/agents/:agent_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Cuerpo de la solicitud
Tipo de contenido
application/json

basic_info

object

display_name

string

Requerido

Max40

ejemploAcme Bank

Display name of the RCS agent shown to end users

sender_id

string

Requerido

Max50

ejemploacme-bank

Unique sender identifier for the agent

hosting_region

string

Requerido

ejemploEUROPE

Region where the agent is hosted

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Intended use case of the agent

Debe ser uno de:TRANSACTIONALPROMOTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Billing category determining how messages are charged

Debe ser uno de:BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALNON_CONVERSATIONAL

brand_id

string(uuid)

Requerido

Max100

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Identifier of the brand this agent belongs to

account_manager_email

string

ejemplomanager@vonage.com

Vonage account manager email address

reseller_email

string

ejemploreseller@partner.com

Reseller email address, in case the agent is created by a reseller party

visual_design

object

tagline

string

Requerido

Max100

ejemploYour trusted banking assistant

Short tagline describing the agent or brand

brand_color

string

Requerido

ejemplo#FF5733

Brand color in hex format, used for button text and UI elements above the agent phone number. Must meet a minimum contrast ratio of 4.5:1 against white (WCAG 2.0). See the support article

logo_image

string

ejemplohttps://cdn.example.com/logo.png

URL of the agent logo image. Shown as a circular avatar next to messages. Requirements: JPEG or PNG, 224x224 px, max 50 KB. See the support article

banner_image

string

ejemplohttps://cdn.example.com/banner.png

URL of the agent banner image. Displayed as a header when users view the agent business info. Requirements: JPEG, 1440x448 px, max 200 KB. See the support article

phone

array

Requerido

List of phone contact numbers (1-3)

number

string

Requerido

ejemplo+12025551234

Phone number in E.164 format

label

string

Max25

ejemploCustomer Support

Display label for this phone number

array

Requerido

List of email contact addresses (1-3)

address

string

Requerido

Min1

ejemplosupport@example.com

Email address

label

string

Max25

ejemploCustomer Support

Display label for this email address

website

array

Requerido

List of website links (1-3)

url

string

Requerido

ejemplohttps://www.example.com

Website URL

label

string

Max25

ejemploOfficial Website

Display label for this website

privacy_policy

string

ejemplohttps://www.example.com/privacy

URL of the privacy policy

terms_of_service

string

ejemplohttps://www.example.com/terms

URL of the terms of service

application_settings

object

application_id

string

Requerido

ejemploa1b2c3d4-e5f6-7890-abcd-ef1234567890

Vonage application ID to associate with this agent

representative

object

first_name

string

Requerido

Max200

ejemploJane

First name of the authorized representative

last_name

string

Requerido

Max200

ejemploDoe

Last name of the authorized representative

title

string

Max200

ejemploHead of Messaging

Job title of the authorized representative

string

Requerido

ejemplojane.doe@example.com

Email address of the authorized representative

brand_website

string

ejemplohttps://www.example.com

Brand website URL

phone

string

ejemplo+12025551234

Phone number in E.164 format

carrier_requirements

object

version

string

Requerido

ejemplov2

Carrier requirements schema version

points_of_contact

array

first_name

string

Requerido

Max200

ejemploJohn

The first name of the point of contact for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the point of contact for the RCS Agent.

job_title

string

Requerido

Max200

ejemploHead of Messaging

The job title of the point of contact for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the point of contact for the RCS Agent.

phone

string

ejemplo+12025551234

The phone number of the point of contact for the RCS Agent.

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

Max10000

ejemploVisit https://example.com/rcs-agent and follow the onboarding flow.

Instructions for reviewers on how to access and test the agent

urls

array

List of media URLs showcasing the agent (up to 10)

media_type

string

Requerido

ejemploimage

Media type of the preview asset

Debe ser uno de:imagevideo

url

string

Requerido

ejemplohttps://cdn.example.com/preview.png

URL of the preview asset

rcs_agent_discovery_methods

object

selection

array

Requerido

Methods through which users discover the RCS agent

other_input

string

Max500

ejemploPromoted via in-store QR codes

Additional details when OTHER is selected

consent_management

object

Requerido

user_messaging_consent_methods

object

Requerido

selection

array

Requerido

Selected consent methods

other_input

string

Max500

ejemploUsers consent via in-store sign-up forms

Additional details when OTHER is selected

users_opt_in_process

object

Requerido

selection

array

Requerido

Selected opt-in methods

links

array

URLs where users can opt in (up to 10)

first_opt_in_message

string

Requerido

Max1000

ejemploWelcome! You have successfully opted in to receive updates from Acme Bank.

The first message sent to users after opting in

users_opt_out_methods

object

Requerido

selection

array

Requerido

Selected opt-out methods

other_input

string

Max500

ejemploUsers can opt out via the account settings page

Additional details when OTHER is selected

opt_out_processing_time

object

Requerido

selection

string

Requerido

ejemploWITHIN_5_MINUTES

How quickly opt-out requests are processed

Debe ser uno de:WITHIN_5_MINUTESWITHIN_24_HOURSOTHER

other_input

string

Max500

ejemploProcessed within 2 business days

Additional details when OTHER is selected

opt_out_confirmation_message

object

Requerido

selection

string

Requerido

ejemploSUCCESSFULLY_UNSUBSCRIBED

Confirmation message template sent after opt-out

Debe ser uno de:SUCCESSFULLY_UNSUBSCRIBEDWONT_RECEIVE_FURTHER_MESSAGESOPT_OUT_REQUEST_PROCESSEDREPLY_START_TO_RESUBSCRIBEOPT_OUT_CONFIRMEDOTHER

other_input

string

Max500

ejemploYou have been unsubscribed. Contact support@example.com to resubscribe.

Additional details when OTHER is selected

cta_language

string

Min1

Max2000

ejemploReply YES to receive exclusive offers from Acme Bank.

Call-to-action language used in consent flows

engagement_flows

object

Requerido

agent_description

string

Requerido

Max5000

ejemploAcme Bank RCS agent helps customers check balances, receive transaction alerts, and manage payments.

Description of what the agent does and how it engages with users

reasons_messages_sent

object

Requerido

Reasons why messages are sent to users

selection

array

Requerido

Selected reasons for sending messages

other_input

string

Max500

ejemploSending loyalty program milestone notifications

Additional details when OTHER is selected

monthly_user_message_count

string

Requerido

ejemploTHREE_FIVE_MESSAGES

Estimated number of messages sent to each user per month

Debe ser uno de:ONE_TWO_MESSAGESTHREE_FIVE_MESSAGESSIX_TEN_MESSAGESELEVEN_TWENTY_MESSAGESMORE_THAN_TWENTY_ONE_MESSAGES

rcs_user_interaction_types

object

Requerido

Types of interactions users have with the agent

selection

array

Requerido

Selected types of RCS user interactions

other_input

string

Max500

ejemploUsers interact via custom carousels

Additional details when OTHER is selected

help_interaction

string

Min1

Max2000

ejemploReply HELP for assistance or visit https://www.example.com/support

How the agent responds to HELP messages from users

message_samples

array

Sample messages the agent will send to users (3-10 samples required)

message_type

string

ejemploRICH_MEDIA

Type of RCS messages the agent sends. Use RICH_TEXT or RICH_MEDIA for US carriers; BASIC or SINGLE for non-US carriers.

Debe ser uno de:RICH_TEXTRICH_MEDIABASICSINGLE

agent_summary

object

program_summary

string

Min1

Max2000

ejemploAcme Bank sends transactional alerts and OTP messages to account holders who have opted in.

Summary of the agent messaging program and its intended use

current_traffic

object

organic_website_traffic

object

Current organic website traffic range

min

integer(int64)

max

integer(int64)

existing_shortcode_traffic

boolean

ejemplotrue

Whether the brand currently uses a shortcode for messaging

shortcode_monthly_traffic

object

Monthly traffic volume range for the existing shortcode

min

integer(int64)

max

integer(int64)

shortcode

string

Max50

ejemplo12345

Existing shortcode number

carriers

array

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Accepted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique agent identifier

state

string

ejemploDRAFT

Current state of the agent

Debe ser uno de:DRAFTCREATEDPENDINGLAUNCHEDREJECTEDUNLAUNCHED

basic_info

object

Requerido

display_name

string

Requerido

Max40

ejemploAcme Bank

Display name of the RCS agent shown to end users

sender_id

string

Requerido

Max50

ejemploacme-bank

Unique sender identifier for the agent

hosting_region

string

Requerido

ejemploEUROPE

Region where the agent is hosted

Debe ser uno de:NORTH_AMERICAEUROPEASIA_PACIFIC

agent_purpose

string

Requerido

ejemploTRANSACTIONAL

Intended use case of the agent

Debe ser uno de:TRANSACTIONALPROMOTIONALOTPMULTI_USE

billing_category

string

Requerido

ejemploCONVERSATIONAL

Billing category determining how messages are charged

Debe ser uno de:BASIC_MESSAGESINGLE_MESSAGECONVERSATIONALNON_CONVERSATIONAL

brand_id

string(uuid)

Requerido

Max100

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Identifier of the brand this agent belongs to

account_manager_email

string

ejemplomanager@vonage.com

Vonage account manager email address

reseller_email

string

ejemploreseller@partner.com

Reseller email address, in case the agent is created by a reseller party

visual_design

object

tagline

string

Requerido

Max100

ejemploYour trusted banking assistant

Short tagline describing the agent or brand

brand_color

string

Requerido

ejemplo#FF5733

Brand color in hex format, used for button text and UI elements above the agent phone number. Must meet a minimum contrast ratio of 4.5:1 against white (WCAG 2.0). See the support article

logo_image

string

ejemplohttps://cdn.example.com/logo.png

URL of the agent logo image. Shown as a circular avatar next to messages. Requirements: JPEG or PNG, 224x224 px, max 50 KB. See the support article

banner_image

string

ejemplohttps://cdn.example.com/banner.png

URL of the agent banner image. Displayed as a header when users view the agent business info. Requirements: JPEG, 1440x448 px, max 200 KB. See the support article

phone

array

Requerido

List of phone contact numbers (1-3)

number

string

Requerido

ejemplo+12025551234

Phone number in E.164 format

label

string

Max25

ejemploCustomer Support

Display label for this phone number

array

Requerido

List of email contact addresses (1-3)

address

string

Requerido

Min1

ejemplosupport@example.com

Email address

label

string

Max25

ejemploCustomer Support

Display label for this email address

website

array

Requerido

List of website links (1-3)

url

string

Requerido

ejemplohttps://www.example.com

Website URL

label

string

Max25

ejemploOfficial Website

Display label for this website

privacy_policy

string

ejemplohttps://www.example.com/privacy

URL of the privacy policy

terms_of_service

string

ejemplohttps://www.example.com/terms

URL of the terms of service

application_settings

object

application_id

string

Requerido

ejemploa1b2c3d4-e5f6-7890-abcd-ef1234567890

Vonage application ID to associate with this agent

test_devices

array

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique test device identifier

phone

string

Requerido

ejemplo+12025551234

Phone number of the test device in E.164 format

created_at

string

Requerido

Date and time when the test device was added

status

string

Requerido

ejemploACTIVE

Status of the test device registration

representative

object

first_name

string

Requerido

Max200

ejemploJane

First name of the authorized representative

last_name

string

Requerido

Max200

ejemploDoe

Last name of the authorized representative

title

string

Max200

ejemploHead of Messaging

Job title of the authorized representative

string

Requerido

ejemplojane.doe@example.com

Email address of the authorized representative

brand_website

string

ejemplohttps://www.example.com

Brand website URL

phone

string

ejemplo+12025551234

Phone number in E.164 format

carrier_requirements

object

version

string

Requerido

ejemplov2

Carrier requirements schema version

points_of_contact

array

first_name

string

Requerido

Max200

ejemploJohn

The first name of the point of contact for the RCS Agent.

last_name

string

Requerido

Max200

ejemploDoe

The last name of the point of contact for the RCS Agent.

job_title

string

Requerido

Max200

ejemploHead of Messaging

The job title of the point of contact for the RCS Agent.

string

Requerido

ejemplojohn.doe@example.com

The email address of the point of contact for the RCS Agent.

phone

string

ejemplo+12025551234

The phone number of the point of contact for the RCS Agent.

agent_preview

object

Requerido

agent_access_instructions

string

Requerido

Max10000

ejemploVisit https://example.com/rcs-agent and follow the onboarding flow.

Instructions for reviewers on how to access and test the agent

urls

array

List of media URLs showcasing the agent (up to 10)

media_type

string

Requerido

ejemploimage

Media type of the preview asset

Debe ser uno de:imagevideo

url

string

Requerido

ejemplohttps://cdn.example.com/preview.png

URL of the preview asset

rcs_agent_discovery_methods

object

selection

array

Requerido

Methods through which users discover the RCS agent

other_input

string

Max500

ejemploPromoted via in-store QR codes

Additional details when OTHER is selected

consent_management

object

Requerido

user_messaging_consent_methods

object

Requerido

selection

array

Requerido

Selected consent methods

other_input

string

Max500

ejemploUsers consent via in-store sign-up forms

Additional details when OTHER is selected

users_opt_in_process

object

Requerido

selection

array

Requerido

Selected opt-in methods

links

array

URLs where users can opt in (up to 10)

first_opt_in_message

string

Requerido

Max1000

ejemploWelcome! You have successfully opted in to receive updates from Acme Bank.

The first message sent to users after opting in

users_opt_out_methods

object

Requerido

selection

array

Requerido

Selected opt-out methods

other_input

string

Max500

ejemploUsers can opt out via the account settings page

Additional details when OTHER is selected

opt_out_processing_time

object

Requerido

selection

string

Requerido

ejemploWITHIN_5_MINUTES

How quickly opt-out requests are processed

Debe ser uno de:WITHIN_5_MINUTESWITHIN_24_HOURSOTHER

other_input

string

Max500

ejemploProcessed within 2 business days

Additional details when OTHER is selected

opt_out_confirmation_message

object

Requerido

selection

string

Requerido

ejemploSUCCESSFULLY_UNSUBSCRIBED

Confirmation message template sent after opt-out

Debe ser uno de:SUCCESSFULLY_UNSUBSCRIBEDWONT_RECEIVE_FURTHER_MESSAGESOPT_OUT_REQUEST_PROCESSEDREPLY_START_TO_RESUBSCRIBEOPT_OUT_CONFIRMEDOTHER

other_input

string

Max500

ejemploYou have been unsubscribed. Contact support@example.com to resubscribe.

Additional details when OTHER is selected

cta_language

string

Min1

Max2000

ejemploReply YES to receive exclusive offers from Acme Bank.

Call-to-action language used in consent flows

engagement_flows

object

Requerido

agent_description

string

Requerido

Max5000

ejemploAcme Bank RCS agent helps customers check balances, receive transaction alerts, and manage payments.

Description of what the agent does and how it engages with users

reasons_messages_sent

object

Requerido

Reasons why messages are sent to users

selection

array

Requerido

Selected reasons for sending messages

other_input

string

Max500

ejemploSending loyalty program milestone notifications

Additional details when OTHER is selected

monthly_user_message_count

string

Requerido

ejemploTHREE_FIVE_MESSAGES

Estimated number of messages sent to each user per month

Debe ser uno de:ONE_TWO_MESSAGESTHREE_FIVE_MESSAGESSIX_TEN_MESSAGESELEVEN_TWENTY_MESSAGESMORE_THAN_TWENTY_ONE_MESSAGES

rcs_user_interaction_types

object

Requerido

Types of interactions users have with the agent

selection

array

Requerido

Selected types of RCS user interactions

other_input

string

Max500

ejemploUsers interact via custom carousels

Additional details when OTHER is selected

help_interaction

string

Min1

Max2000

ejemploReply HELP for assistance or visit https://www.example.com/support

How the agent responds to HELP messages from users

message_samples

array

Sample messages the agent will send to users (3-10 samples required)

message_type

string

ejemploRICH_MEDIA

Type of RCS messages the agent sends. Use RICH_TEXT or RICH_MEDIA for US carriers; BASIC or SINGLE for non-US carriers.

Debe ser uno de:RICH_TEXTRICH_MEDIABASICSINGLE

agent_summary

object

program_summary

string

Min1

Max2000

ejemploAcme Bank sends transactional alerts and OTP messages to account holders who have opted in.

Summary of the agent messaging program and its intended use

current_traffic

object

organic_website_traffic

object

Current organic website traffic range

min

integer(int64)

max

integer(int64)

existing_shortcode_traffic

boolean

ejemplotrue

Whether the brand currently uses a shortcode for messaging

shortcode_monthly_traffic

object

Monthly traffic volume range for the existing shortcode

min

integer(int64)

max

integer(int64)

shortcode

string

Max50

ejemplo12345

Existing shortcode number

carriers

array

string

Requerido

ejemplogoogle-us-att

Carrier identifier

launch_state

string

Current launch state for this carrier

update_time

string

Date and time of the last status update

launch_submitted_at

string

Date and time when the launch was submitted for this carrier

comment

string

Comment or reason associated with the current launch state

verification_details

object

status

string

ejemploVERIFICATION_STATE_VERIFIED

Verification status of the agent

Debe ser uno de:VERIFICATION_STATE_UNSPECIFIEDVERIFICATION_STATE_UNVERIFIEDVERIFICATION_STATE_PENDINGVERIFICATION_STATE_VERIFIED

brand_details

object

organization_name

string

Requerido

Max255

legal_form

string

Requerido

Max50

stock_symbol

string

Max12

legal_entity_type

string

Requerido

Max50

country_of_registration

string

Requerido

Min2

Max2

federal_tax_id

string

Max50

business_website_url

string

Requerido

Max255

address_line1

string

Requerido

Max255

address_line2

string

Max255

city

string

Requerido

Max100

state_or_province

string

Requerido

Max100

zip_or_post_code

string

Requerido

Max15

launch_submitted_at

string

Date and time when the agent launch was submitted

created_at

string

Date and time when the agent was created

updated_at

string

Date and time when the agent was last updated

Ejemplo Respuesta

Get Carriers

Retrieve a list of available carriers for RCS.

gethttps://api.nexmo.com/v2/channel-manager/rcs/metadata/carriers

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

carriers

array

Requerido

A list of available carriers for RCS.

string

Requerido

ejemploverizon-us

A unique identifier for the carrier.

carrier

string

Requerido

ejemploVerizon

The name of the carrier.

country_letter_code

string

Requerido

ejemploUS

Code for the country where the carrier operates.

Ejemplo Respuesta

Add Carriers to Agent

Add carriers to an existing RCS Agent.

posthttps://api.nexmo.com/v2/channel-manager/rcs/agents/:agent_id/carriers

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Cuerpo de la solicitud
Tipo de contenido
application/json

carriers

array

Requerido

An array of Carrier IDs to add to the RCS Agent.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Accepted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

message

string

Requerido

ejemploRequest accepted for processing

Ejemplo Respuesta

Launch RCS Agent

Launch an existing RCS Agent

posthttps://api.nexmo.com/v2/channel-manager/rcs/agents/:agent_id/launch

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Respuestas
Tipo de contenido
application/json

Accepted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

message

string

Requerido

ejemploRequest accepted for processing

Ejemplo Respuesta

Add Test Devices to Agent

Add test devices to an existing RCS Agent.

posthttps://api.nexmo.com/v2/channel-manager/rcs/agents/:agent_id/test-devices

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

Cuerpo de la solicitud
Tipo de contenido
application/json

phone

string

Requerido

ejemplo+14155552671

The phone number to add to the RCS Agent in E.164 format.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Accepted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string(uuid)

Requerido

ejemplo0198ecd4-da21-7f8b-91d8-ccfbaec485a7

Unique test device identifier

phone

string

Requerido

ejemplo+12025551234

Phone number of the test device in E.164 format

created_at

string

Requerido

Date and time when the test device was added

status

string

Requerido

ejemploACTIVE

Status of the test device registration

Ejemplo Respuesta

Remove Test Device from Agent

Remove a test device from an existing RCS Agent.

deletehttps://api.nexmo.com/v2/channel-manager/rcs/agents/:agent_id/test-devices/:test_device_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

agent_id

string

Requerido

ejemplo78d335fa-323d-0114-9c3d-d6f0d48968cf

Agent ID

test_device_id

string

Requerido

ejemplo019809ba-a274-7bd2-aea0-f1f70f2210dc

Test Device Id

Respuestas

No Content - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

RCS Deeplinks

API endpoints relating to generating RCS Deeplinks

Operaciones disponibles

Generate RCS Deeplink

Generate RCS Deeplink

Generate an RCS deeplink for a specific RCS agent and use case. See the RCS Deeplinks documentation for more information.

posthttps://api.nexmo.com/v1/channel-manager/rcs/deeplink/generate

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

sender_id

string

Requerido

Max50

ejemploacme_agent

Messages API sender ID (a.k.a. external ID) that identifies the RCS agent.

country

string

Requerido

Min2

Max2

ejemploUS

ISO 3166-1 alpha-2 country code of the country where the deep link will operate.

prefilled_message

string

Max3072

ejemploI'm interested in finding out about your new product. Please send me more details.

Optional pre-defined message that will be populated in the send-message dialog of the SMS/RCS app on the end user's device when the user opens the deep link.

fallback_number

string

ejemplo+15550123456

Optional Vonage virtual number in E.164 format that will be used as the SMS fallback destination if the end user's device does not support RCS.

Ejemplo Solicitar

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

deep_link

string(uri)

Requerido

ejemplohttps://tools.vonage.com/rcs/v1/deeplink/jNiLGT29KY4RVzTczcA83NFFhv28Ut-bdnutpcG8OTv-7a8vt75f3ka1eyDh3L4KZTkJ9qgXHk

The generated RCS deeplink URL.

Channel Manager API

WhatsApp WABAs

Operaciones disponibles

List WhatsApp Business Accounts (WABAs)

Autenticación

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Get a specific WhatsApp Business Account (WABA)

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

List Numbers for a WhatsApp Business Account (WABA)

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Get a specific WhatsApp Business Account (WABA) Number

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Get the profile for a specific WhatsApp Business Account (WABA) Number

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Update the profile for a specific WhatsApp Business Account (WABA) Number

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

WhatsApp Hosted ES Flow

Operaciones disponibles

Generate Hosted ES Flow URL

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

WhatsApp Analytics

Operaciones disponibles

Get Template Analytics

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Get Messaging Analytics

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Get Pricing Analytics

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Enable template analytics

Autenticación

Ruta Parámetros

Respuestas

Cabecera Parámetros

WhatsApp Notification Subscriptions

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json