Jump to Content
Home
Guides
API Reference
v1.1
API Reference
v1.1
Home
Guides
API Reference
Claim a keyword.
Search
JUMP TO
Number Validation API
Number Validation
numbervalidation
get
Number Lookup
numberlookup
get
Capability Check API
Capability Check
capabilitycheck
get
Bulk Capability Check
bulkcapabilitycheck
post
Channels API
ApiSettings
Gets the gateway product tokens asynchronous.
get
Get the API keys for the logical account asynchronous.
get
Determines if the Account ID has Messaging Capability asynchronous.
get
Get whitelisted numbers linked to logical account, if null, no whitelist is active.
get
Send test message
post
Gets the business messaging entity events asynchronous.
get
Gets the ip restriction configuration asynchronous.
get
Updates the ip restriction configuration asynchronous.
put
Adds the ip restriction configuration asynchronous.
post
Deletes the ip restriction configuration asynchronous.
del
Gets the ip restriction suggestions asynchronous.
get
Gets the mt recipient available country filters asynchronous.
get
Gets the mt recipient country filter configuration asynchronous.
get
Updates the mt recipient country filter configuration asynchronous.
put
Adds the mt recipient country filter configuration asynchronous.
post
Deletes the mt recipient country filter configuration asynchronous.
del
Gets the default mt recipient country filter configuration asynchronous.
get
Gets the rate limiting configuration asynchronous.
get
Updates the rate limiting configuration asynchronous.
put
Creates the rate limiting configuration asynchronous.
post
Deletes the rate limiting configuration asynchronous.
del
Gets the rate limiting accepted time units asynchronous.
get
Gets the SMPP configurations asynchronous.
get
Gets the SMPP configuration asynchronous.
get
Gets the sr webhook configuration asynchronous.
get
Puts the sr webhook configuration asynchronous.
put
Posts the sr webhook configuration asynchronous.
post
Deletes the sr webhook configuration asynchronous.
del
Deprecated.
get
Deprecated.
get
Deprecated.
get
Deprecated.
put
Deprecated.
post
Deprecated.
del
Deprecated.
get
Deprecated.
get
Deprecated.
get
Deprecated.
post
AppleBusinessChat
Gets the account asynchronous.
get
Add an abc account.
post
Gets the account form input asynchronous.
get
Adds the account form input asynchronous.
put
ChannelConfiguration
Gets all configurations for a channel.
get
Gets a configuration for a channel.
get
Enables/disables a channel configuration.
put
Adds a channels' email configuration element.
post
Updates a channels' email configuration element.
put
Deletes a channels' email configuration element.
del
Add a channels' web hook configuration element.
post
Updates a channels' webhook configuration element.
put
Deletes a channels' web hook configuration element.
del
Adds an event webhook configuration element.
post
Updates an event webhook configuration element.
put
Deletes an event webhook configuration element.
del
Updates a channels' messaging log configuration.
post
Channels
Verifies the read capabilities asynchronous.
get
Processes a Meta Login for Business attempt.
post
Get a channel request overview.
get
Processes a Meta Login for Business attempt's dialog result.
post
Get all conversational profiles.
get
Gets the channels asynchronous.
get
Gets the channel asynchronous.
get
Get a Channel's UPDATE events.
get
Gets the channel requests asynchronous.
get
Adds the channel request asynchronous.
post
Gets the channel request asynchronous.
get
Gets all channel types.
get
Gets a channel type.
get
Gets channel type categories.
get
Gets a channel type category.
get
Gets the channel request form asynchronous.
get
Get a channel's custom request form.
get
Get a channel's custom request form input.
get
Add input to the channel's custom request form.
put
Handles the demo account channel request asynchronous.
post
Gets the monthly ott metrics asynchronous.
get
Facebook
Get Facebook connections.
get
Update (a) Facebook connection(s) by processing a dialog session code.
put
Get a Facebook connection.
get
Get a Facebook account.
get
Adds a Facebook account.
post
Get a Facebook account's form input.
get
Add input to a Facebook account's form.
put
Instagram
Get Instagram connections.
get
Update (a) Instagram connection(s) by processing a dialog session code.
put
Get a Instagram connection.
get
Get a Instagram account.
get
Adds a Instagram account.
post
Get a Instagram account's form input.
get
Adds the instagram account form input asynchronous.
put
Keywords
Get all claimed keywords (paginated).
get
Claim a keyword.
post
Get a keyword claim by id.
get
Cancel a keyword claim.
del
Line
Gets the line notify services asynchronous.
get
Adds the line notify service asynchronous.
post
Gets the line notify service asynchronous.
get
Updates the line notify service asynchronous.
put
Deletes the line notify service asynchronous.
del
Get a Line account.
get
Adds a Line account.
post
Get a Line account's form input.
get
Adds the Line account form input asynchronous.
put
MobilePush
Gets the mobile push android application asynchronous.
get
Updates the mobile push android application asynchronous.
put
Deletes the mobile push android application asynchronous.
del
Gets the mobile push applications asynchronous.
get
Adds the mobile push application asynchronous.
post
Gets the mobile push application asynchronous.
get
Updates the mobile push application asynchronous.
put
Deletes the mobile push application asynchronous.
del
Gets the mobile push ios application asynchronous.
get
Updates the mobile push ios application asynchronous.
put
Deletes the mobile push ios application asynchronous.
del
Gets the mobile push ios application CSR asynchronous.
get
Posts the mobile push ios application cert asynchronous.
post
ø Gets the mobile push account asynchronous.
get
Adds the mobile push account asynchronous.
post
Gets the mobile push account form input asynchronous.
get
Adds the mobile push account form input asynchronous.
put
Organizations
Get an organization.
get
Get an organization's accounts.
get
Create an organization account.
post
PhoneNumbers
Get all available phone numbers (paginated).
get
Get a phone number by id.
get
Cancel a dedicated phone number.
del
Get all available number types (paginated).
get
Get all dedicated phone number requests (paginated).
get
Request a dedicated phone number.
post
Gets a phone number request by id.
get
RichContentServices
Gets the profiles asynchronous.
get
Adds the profile asynchronous.
post
Gets the profile asynchronous.
get
Gets the profile form input asynchronous.
get
Adds the profile form input asynchronous.
put
Get an RCS account.
get
Add an RCS account.
post
Get an RCS account's form input.
get
Add an RCS account's form input.
put
ScenarioConfiguration
Get scenario configuration scenarios.
get
Add a scenario configuration scenario.
post
Get a scenario by ID.
get
Update a scenario configuration scenario.
put
Deletes the scenario configuration scenario by ID
del
Get a scenario configuration scenario's handlers.
get
Get a scenario configuration scenario's events.
get
Gets scenario configuration countries.
get
Get scenario configuration mediums.
get
Gets the mo handlers administration asynchronous.
get
Add a new MoHandler.
post
Get an MoHandler by ID.
get
Update an MoHandler.
put
Delete an MoHandler.
del
Get an MoHandler's events.
get
Link (a) scenario(s) to an MoHandler by ID.
put
Unlinks the scenarios from mo handler administration asynchronous.
del
Gets the mo handler templates administration asynchronous.
get
Gets the mo handler platform locations administration asynchronous.
get
Status
Gets the status.
get
TenDlc
Get 10DLC brands.
get
Add 10DLC brand.
post
Get a 10DLC brand.
get
Cancel a 10DLC brand.
del
Get 10DLC brand form input.
get
Add 10DLC brand form input.
put
Gets the ten DLC brand vetting status asynchronous.
get
Gets the ten DLC campaigns asynchronous.
get
Get 10DLC campaigns asynchronous.
get
Add 10DLC campaign asynchronous.
post
Get a 10DLC campaign asynchronous.
get
Cancel a 10DLC campaign asynchronous.
del
Get 10DLC campaign form input asynchronous.
get
Add 10DLC campaign form input asynchronous.
put
Search for a 10DLC campaign.
get
Trials
Get a trial status.
get
Get Messaging trial number whitelist.
get
Adds a Messaging trial whitelisted number.
post
Delete a Messaging trial whitelisted number.
del
VerifiedSms
Gets the account asynchronous.
get
Gets the account form input asynchronous.
get
Adds the account form input asynchronous.
put
Viber
Gets the account asynchronous.
get
Adds the viber account asynchronous.
post
Gets the account form input asynchronous.
get
Adds the account form input asynchronous.
put
WhatsApp
Get a WhatsApp business account's marketing lite API eligibility status.
get
Start a WhatsApp business account's Meta business marketing lite API onboarding.
post
Get WhatsApp business account numbers' marketing lite API eligibility status.
post
Gets a WhatsApp business account.
get
Start a WhatsApp business account eligible number's marketing lite API onboarding.
post
Adds the business account asynchronous.
post
Gets the business account form input asynchronous.
get
Processes the embedded sign up session code asynchronous.
post
Adds WhatsApp business account form input.
put
Gets the WhatsApp supported languages.
get
Gets all known WhatsApp profiles.
get
Adds a WhatsApp profile.
post
Gets a WhatsApp profile.
get
Deletes a WhatsApp profile.
del
Gets a WhatsApp profile's form input.
get
Adds WhatsApp profile form input.
put
Updates a WhatsApp profile.
put
Triggers a profile phone number one-time-password.
get
Validates a profile phone number.
post
Finalize an imported via embedded sign up and ownership-verified profile.
post
Get a profile's conversational components.
get
Update a profile's conversational components.
put
Gets all known WhatsApp sandbox profiles.
get
Adds a WhatsApp sandbox profile.
post
Gets a WhatsApp sandbox profile.
get
Deletes a WhatsApp sandbox profile.
del
Gets the expire date for sandbox profiles in a channel group.
get
Gets supported WhatsApp template categories.
get
Gets all WhatsApp templates.
get
Adds a WhatsApp template.
post
Gets a WhatsApp template.
get
Updates a WhatsApp template.
put
Deletes a template.
del
Gets a template language.
get
Updates the template header settings asynchronous.
put
Updates the template interactive settings asynchronous.
put
Updates the template language interactive settings asynchronous.
put
Updates the template language carousel settings asynchronous.
put
Updates the template language time to live settings asynchronous.
put
Requests validation for a template.
post
Adds a replacement field to a template.
post
Updates a template replacement field.
put
Removes a replacement field from a template.
del
Gets the enabled languages for a template.
get
Adds an enabled language for a template.
post
Removes an enabled language for a template.
del
Get a template's Meta analytics.
get
Get a template's supplier status.
get
Get a template language's supplier status.
get
Email Gateway API
Email Alerts
List all alerts
get
Create a alert
post
Update a alert
put
Delete a alert
del
Email Service
Send Marketing Emails
post
Send Transactional Emails
post
Unsubscribe Service
Email Unsubscribe
post
Domains
Add a domain
post
Verify a domain
post
Delete a domain
del
List all domains
get
Webhooks Service
Create or update a webhook
post
Delete a webhook
del
List webhooks
get
Email Suppressions
Add suppression via unique key
post
List email suppressions
get
Add Email Suppressions manually
post
Claim a keyword.
post
https://api.cm.com/channels/v1/accounts/
{accountId}
/keywords
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
