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.

Download OpenAPI Specification

WhatsApp WABAs

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

Available Operations

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

Authentication

This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.

You can use either JWT or Basic authentication, but not both at the same time.

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Query Parameters

page

integer

example1

The page number to retrieve.

page_size

integer

example50

The number of WhatsApp WABAs to return per page.

order

string

The order in which to return WhatsApp WABAs.

Must be one of:ascdesc

Responses
Content Type
application/json

page_size

integer

example50

The maximum number of WhatsApp WABAs returned per page.

page

integer

example1

The current page number within the set of pages.

total_pages

integer

example5

The total number of pages within the set of pages.

total_items

integer

example219

The total number of WhatsApp WABAs within the overall record set.

_embedded

object

wabas

array

waba_id

string

Required

example345688589250625

The ID of the WhatsApp Business Account.

api_key

string

Required

exampleabc123

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

name

string

Required

exampleMy Business

The name of the WhatsApp Business Account.

account_review_status

string

Required

exampleApproved

The review status of the WhatsApp Business Account.

Must be one of:PendingApprovedRejected

timezone_id

string

Required

example58

The ID of the timezone of the WhatsApp Business Account.

currency

string

Required

exampleUSD

The currency of the WhatsApp Business Account.

solution_id

string

example1234567890

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

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc

The URL to the current page of WhatsApp WABAs.

first

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc

The URL to the first page of WhatsApp WABAs.

last

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=5&page_size=50&order=asc

The URL to the last page of WhatsApp WABAs.

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=2&page_size=50&order=asc

The URL to the next page of WhatsApp WABAs.

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc

The URL to the previous page of WhatsApp WABAs.

Example Response

{
   "page_size": 50,
   "page": 1,
   "total_pages": 5,
   "total_items": 219,
   "_embedded": {
      "wabas": [
         {
            "waba_id": "345688589250625",
            "api_key": "abc123",
            "name": "My Business",
            "account_review_status": "Approved",
            "timezone_id": "58",
            "currency": "USD",
            "solution_id": "1234567890"
         }
      ]
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc"
      },
      "first": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc"
      },
      "last": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=5&page_size=50&order=asc"
      },
      "next": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=2&page_size=50&order=asc"
      },
      "prev": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas?page=1&page_size=50&order=asc"
      }
   }
}

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

Authentication

This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.

You can use either JWT or Basic authentication, but not both at the same time.

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

waba_id

string

Required

example345688589250625

The waba_id of the WhatsApp Business Account (WABA) to retrieve.

Responses
Content Type
application/json

waba_id

string

Required

example345688589250625

The ID of the WhatsApp Business Account.

api_key

string

Required

exampleabc123

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

name

string

Required

exampleMy Business

The name of the WhatsApp Business Account.

account_review_status

string

Required

exampleApproved

The review status of the WhatsApp Business Account.

Must be one of:PendingApprovedRejected

timezone_id

string

Required

example58

The ID of the timezone of the WhatsApp Business Account.

currency

string

Required

exampleUSD

The currency of the WhatsApp Business Account.

solution_id

string

example1234567890

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

_links

object

self

object

href

string

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

The URL to the WhatsApp Business Account (WABA) being retrieved.

numbers

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers

The URL to list the phone numbers associated with the WhatsApp Business Account (WABA).

Example Response

{
   "waba_id": "345688589250625",
   "api_key": "abc123",
   "name": "My Business",
   "account_review_status": "Approved",
   "timezone_id": "58",
   "currency": "USD",
   "solution_id": "1234567890",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625"
      },
      "numbers": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers"
      }
   }
}

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

Authentication

This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.

You can use either JWT or Basic authentication, but not both at the same time.

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

waba_id

string

Required

example345688589250625

The waba_id of the WhatsApp Business Account (WABA) with which the numbers are associated.

Query Parameters

page

integer

example1

The page number to retrieve.

page_size

integer

example50

The number of WhatsApp WABAs to return per page.

order

string

The order in which to return WhatsApp WABAs.

Must be one of:ascdesc

Responses
Content Type
application/json

page_size

integer

example50

The maximum number of WABA numbers returned per page.

page

integer

example1

The current page number within the set of pages.

total_pages

integer

example5

The total number of pages within the set of pages.

total_items

integer

example219

The total number of WABA numbers within the overall record set.

_embedded

object

wabas

array

phone_number

string

Required

example447451277751

The phone number associated with the WhatsApp Business Account.

number_id

string

Required

example293464193855848

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

waba_id

string

Required

example345688589250625

The ID of the WhatsApp Business Account.

api_key

string

Required

exampleabc123

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

verified_name

string

exampleMy Business

The WhatsApp display name for number

code_verification_status

string

exampleVERIFIED

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.

Must be one of:NOT_VERIFIEDVERIFIEDEXPIRED

display_phone_number

string

example+447451277751

How the number is displayed on WhatsApp accounts.

messaging_limit_tier

string

exampleTIER_100K

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

Must be one of: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

exampleGREEN

The quality score of the phone number.

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

Must be one of: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

exampleSTANDARD

The throughput rate of the phone number.

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751

The URL to the current page of WhatsApp WABAs.

first

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=1&page_size=50&order=asc

The URL to the first page of WhatsApp WABAs.

last

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=5&page_size=50&order=asc

The URL to the last page of WhatsApp WABAs.

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=2&page_size=50&order=asc

The URL to the next page of WhatsApp WABAs.

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=1&page_size=50&order=asc

The URL to the previous page of WhatsApp WABAs.

Example Response

{
   "page_size": 50,
   "page": 1,
   "total_pages": 5,
   "total_items": 219,
   "_embedded": {
      "wabas": [
         {
            "phone_number": "447451277751",
            "number_id": "293464193855848",
            "waba_id": "345688589250625",
            "api_key": "abc123",
            "verified_name": "My Business",
            "code_verification_status": "VERIFIED",
            "display_phone_number": "+447451277751",
            "messaging_limit_tier": "TIER_100K",
            "quality_score": {
               "score": "GREEN"
            },
            "throughput": {
               "level": "STANDARD"
            }
         }
      ]
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751"
      },
      "first": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=1&page_size=50&order=asc"
      },
      "last": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=5&page_size=50&order=asc"
      },
      "next": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=2&page_size=50&order=asc"
      },
      "prev": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers?page=1&page_size=50&order=asc"
      }
   }
}

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

Authentication

This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.

You can use either JWT or Basic authentication, but not both at the same time.

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

waba_id

string

Required

example345688589250625

The waba_id of the WhatsApp Business Account (WABA) to retrieve.

whatsapp_number

string

Required

example447451277751

The whatsapp_number for which to retrieve the details.

Responses
Content Type
application/json

phone_number

string

Required

example447451277751

The phone number associated with the WhatsApp Business Account.

number_id

string

Required

example293464193855848

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

waba_id

string

Required

example345688589250625

The ID of the WhatsApp Business Account.

api_key

string

Required

exampleabc123

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

verified_name

string

exampleMy Business

The WhatsApp display name for number

code_verification_status

string

exampleVERIFIED

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.

Must be one of:NOT_VERIFIEDVERIFIEDEXPIRED

display_phone_number

string

example+447451277751

How the number is displayed on WhatsApp accounts.

messaging_limit_tier

string

exampleTIER_100K

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

Must be one of: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

exampleGREEN

The quality score of the phone number.

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

Must be one of: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

exampleSTANDARD

The throughput rate of the phone number.

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751

The URL to the WhatsApp Business Account (WABA) Number being retrieved.

Example Response

{
   "phone_number": "447451277751",
   "number_id": "293464193855848",
   "waba_id": "345688589250625",
   "api_key": "abc123",
   "verified_name": "My Business",
   "code_verification_status": "VERIFIED",
   "display_phone_number": "+447451277751",
   "messaging_limit_tier": "TIER_100K",
   "quality_score": {
      "score": "GREEN"
   },
   "throughput": {
      "level": "STANDARD"
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751"
      }
   }
}

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/wabas/:waba_id/numbers/:whatsapp_number/profile

Authentication

This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.

You can use either JWT or Basic authentication, but not both at the same time.

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

waba_id

string

Required

example345688589250625

The waba_id of the WhatsApp Business Account (WABA) with which the number is associated.

whatsapp_number

string

Required

example447451277751

The whatsapp_number for which to retrieve the profile details.

Responses
Content Type
application/json

about

string

exampleAbout my business

Information about the profile

address

string

example123 Main Street, Anytown, USA

The address of the profile

description

string

exampleDescription of my business

The description of the profile

string

examplebob@example.com

The email address of the profile

profile_picture_url

string(uri)

examplehttps://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

exampleOTHER

The Industry or Business Category of the WhatsApp Profile

Must be one of:APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVEL

messaging_product

string

examplewhatsapp

The messaging product with which the profile is associated.

Must be one of:whatsapp

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751

The URL to the profile being retrieved.

Example Response

{
   "about": "About my business",
   "address": "123 Main Street, Anytown, USA",
   "description": "Description of my business",
   "email": "bob@example.com",
   "profile_picture_url": "https://example.com/profile.png",
   "websites": [
      "https://example.com",
      "https://example.org"
   ],
   "vertical": "OTHER",
   "messaging_product": "whatsapp",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751"
      }
   }
}

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/wabas/:waba_id/numbers/:whatsapp_number/profile

Authentication

This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.

You can use either JWT or Basic authentication, but not both at the same time.

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

waba_id

string

Required

example345688589250625

The waba_id of the WhatsApp Business Account (WABA) with which the number is associated.

whatsapp_number

string

Required

example447451277751

The whatsapp_number for which to update the profile details.

Request Body
Content Type
application/json

about

string

exampleAbout my business

Information about the profile

address

string

example123 Main Street, Anytown, USA

The address of the profile

description

string

exampleDescription of my business

The description of the profile

string

examplebob@example.com

The email address of the profile

profile_picture_url

string(uri)

examplehttps://example.com/profile.png

websites

array

URLs of websites for the profile

vertical

string

exampleOTHER

The Industry or Business Category of the WhatsApp Profile

Must be one of:APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVEL

Example Request

{
   "about": "About my business",
   "address": "123 Main Street, Anytown, USA",
   "description": "Description of my business",
   "email": "bob@example.com",
   "profile_picture_url": "https://example.com/profile.png",
   "websites": [
      "https://example.com",
      "https://example.org"
   ],
   "vertical": "OTHER"
}

{
   "about": "About my business",
   "address": "123 Main Street, Anytown, USA",
   "description": "Description of my business",
   "email": "bob@example.com",
   "profile_picture_url": "https://example.com/profile.png",
   "websites": [
      "https://example.com",
      "https://example.org"
   ],
   "vertical": "OTHER"
}

Responses
Content Type
application/json

about

string

exampleAbout my business

Information about the profile

address

string

example123 Main Street, Anytown, USA

The address of the profile

description

string

exampleDescription of my business

The description of the profile

string

examplebob@example.com

The email address of the profile

profile_picture_url

string(uri)

examplehttps://example.com/profile.png

websites

array

URLs of websites for the profile

vertical

string

exampleOTHER

The Industry or Business Category of the WhatsApp Profile

Must be one of:APPARELAUTOBEAUTYEDUENTERTAINEVENT_PLANFINANCEGOVTGROCERYHEALTHHOTELNONPROFITOTHERPROF_SERVICESRESTAURANTRETAILTRAVEL

messaging_product

string

examplewhatsapp

The messaging product with which the profile is associated.

Must be one of:whatsapp

_links

object

self

object

href

string

examplehttps://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751

The URL to the profile being updated.

Example Response

{
   "about": "About my business",
   "address": "123 Main Street, Anytown, USA",
   "description": "Description of my business",
   "email": "bob@example.com",
   "profile_picture_url": "https://example.com/profile.png",
   "websites": [
      "https://example.com",
      "https://example.org"
   ],
   "vertical": "OTHER",
   "messaging_product": "whatsapp",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/numbers/447451277751"
      }
   }
}

RCS Capability Checks

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

Available Operations

RCS Capabilities Device Check

Get RCS Capabilities for a Specific Device

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

Authentication

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`

Path Parameters

sender_id

string

Required

exampleVonageAgent

The Sender ID of your RCS Agent.

phone_number

string

Required

example447900000000

The phone number of the device to check.

Responses
Content Type
application/json

features

array

A list of RCS capabilities for the device being checked.

Example Response

{
   "features": [
      "RICHCARD",
      "RICHCARD_CAROUSEL",
      "CREATE_CALENDAR_EVENT",
      "DIAL_PHONE_NUMBER",
      "OPEN_URL",
      "SHARE_LOCATION",
      "VIEW_LOCATION"
   ]
}

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

Authentication

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`

Path Parameters

sender_id

string

Required

exampleVonageAgent

The Sender ID of your RCS Agent.

operation

string

Required

The operation to perform.

Must be one of:users:batchGet

Request Body
Content Type
application/json

users

array

An array of phone numbers to check.

Example Request

{
   "users": [
      "447900000000",
      "447900000001"
   ]
}

{
   "users": [
      "447900000000",
      "447900000001"
   ]
}

Responses
Content Type
application/json

One Of

reachableUsers

array

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

Example Response»Response where 500 numbers or less submitted.

{
   "reachableUsers": [
      "447900000000",
      "447900000001"
   ]
}

WhatsApp Template Analytics

API endpoints relating to analytics data for WhatsApp Templates

Available Operations

Get Template Analytics

Get Template Analytics

Get analytics for a specific template.

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

Authentication

This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.

You can use either JWT or Basic authentication, but not both at the same time.

Key	Description	Where	Example
Authorization	Your JSON web token. Read more about JWTs	Headers	`Bearer <JWT>`
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

waba_id

string

Required

example345688589250625

The waba_id of the WhatsApp Business Account (WABA) for which to retrieve the template analytics data.

Query Parameters

template_ids

array

Min1

Max10

example

[
  "458951126288937",
  "458951126288942"
]

An array of the template_ids of the template(s) to retrieve analytics for.

start

string(timestamp)

example2024-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)

example2024-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

example

[
  "SENT",
  "DELIVERED"
]

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

granularity

string

exampleDAILY

The granularity of the analytics data to be retrieved.

Must be one of:DAILY

Responses
Content Type
application/json

granularity

string

exampleDAILY

The granularity of the template analytics retrieved.

Must be one of:DAILY

product_type

string

examplecloud_api

The product type for which the template analytics were retrieved.

page_size

integer

example100

The maximum number of template analytics returned per page.

_embedded

object

template_analytics

array

template_id

string

Required

example458951126288942

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

start

string(date-time)

Required

example2024-11-11T00:00:00Z

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

end

string(date-time)

Required

example2024-11-11T00:00:00Z

The end date and time in ISO-8601 format for the analytics data to be retrieved to.

sent

integer

example100

The number of messages sent using the WhatsApp Template.

delivered

integer

example90

The number of messages delivered using the WhatsApp Template.

read

integer

example80

The number of messages read using the WhatsApp Template.

clicked

integer

example70

The number of messages clicked using the WhatsApp Template.

_links

object

self

object

href

string

example

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.

Example Response

{
   "granularity": "DAILY",
   "product_type": "cloud_api",
   "page_size": 100,
   "_embedded": {
      "template_analytics": [
         {
            "template_id": "458951126288942",
            "start": "2024-11-11T00:00:00Z",
            "end": "2024-11-11T00:00:00Z",
            "sent": 100,
            "delivered": 90,
            "read": 80,
            "clicked": 70
         }
      ]
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/template-analytics?template_ids=[458951126288937]&start=2024-11-10&end=2024-11-14&page_size=100&cursor=c2VsZj1udWxs"
      }
   }
}

Channel Manager API

WhatsApp WABAs

Available Operations

List WhatsApp Business Accounts (WABAs)

Authentication

Query Parameters

Responses Content Typeapplication/json

Example Response

Get a specific WhatsApp Business Account (WABA)

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

List Numbers for a WhatsApp Business Account (WABA)

Authentication

Path Parameters

Query Parameters

Responses Content Typeapplication/json

Example Response

Get a specific WhatsApp Business Account (WABA) Number

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

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

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

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

Authentication

Path Parameters

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response

RCS Capability Checks

Available Operations

RCS Capabilities Device Check

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

RCS Capabilities Bulk Check

Authentication

Path Parameters

Request Body Content Typeapplication/json

Example Request

Responses Content Typeapplication/json

Example Response»Response where 500 numbers or less submitted.

WhatsApp Template Analytics

Available Operations

Get Template Analytics

Authentication

Path Parameters

Query Parameters

Responses Content Typeapplication/json

Example Response

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Request Body
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json