SMS API

Getting started with SMS API
Send SMS API
Reporting API
Engage API
- Send SMS Engage surveypost
- Send SMS Engage surveys as batchpost
Webhook Configuration API
SMS Callbacks Reference
SMS Delivery receipts error codes

Business Messaging API

Getting started with Messaging API
Send Message API
Supported Messaging Apps
Supported Messaging Apps Content Types
Management API
Reporting API
Webhook Configuration API
Messaging Apps Callbacks Reference
Messaging Apps Fallback management
Delivery Error Codes

Verification API

Getting started with Verification API
Verification API

Voice V1 API

Voice Messaging
Getting started with Voice API
Voice Messaging
IVR
Voice Profile API
- Get speech profiles for your accountget
Webhooks API
Voice Call Action Webhook
- Call Action Handling (IVR)
Error Code ( Voice Messaging & IVR)
- Status Code and Status Message (Voice Messaging & IVR)
Recording API
Virtual Number Management API
- Get My Virtual Numbersget
- Check Virtual Numberget

Number Masking API

Getting started with Number Masking
How to implement 8x8 Number Masking?
Webhooks API
Call Status (Number Masking)
Call Action Handling (Number Masking)
Session Summary (Number Masking)
Error Codes (Number Masking)
Virtual Number Updated
Call Recordings

Video Interaction API

Introduction
Management API
- Token creationpost
Getting Started
Reporting API
Token example creation
iframe integration

Number Lookup API

Getting started with Number Lookup API
Number Lookup API
- Get phone number lookup dataget
Number Lookup Error Codes

Automation API

Getting started with Automation API
Workflow Definition Management
Workflow Instance Management
Workflow Triggers
- Trigger workflows using an external eventpost
Miscellaneous

Contacts API

Getting started with Contacts API
Contacts API
Groups API
Batch API

General API information

API Error codes
Message status reference
Price object reference
Webhook object structure
Security
IP address list

SMPP

SMPP - Connection
SMPP TLVs
SMPP - Delivery receipts
SMPP - Data encoding

SMS API

Getting started with SMS API
Send SMS API
Reporting API
Engage API
- Send SMS Engage surveypost
- Send SMS Engage surveys as batchpost
Webhook Configuration API
SMS Callbacks Reference
SMS Delivery receipts error codes

Business Messaging API

Getting started with Messaging API
Send Message API
Supported Messaging Apps
Supported Messaging Apps Content Types
Management API
Reporting API
Webhook Configuration API
Messaging Apps Callbacks Reference
Messaging Apps Fallback management
Delivery Error Codes

Verification API

Getting started with Verification API
Verification API

Voice V1 API

Voice Messaging
Getting started with Voice API
Voice Messaging
IVR
Voice Profile API
- Get speech profiles for your accountget
Webhooks API
Voice Call Action Webhook
- Call Action Handling (IVR)
Error Code ( Voice Messaging & IVR)
- Status Code and Status Message (Voice Messaging & IVR)
Recording API
Virtual Number Management API
- Get My Virtual Numbersget
- Check Virtual Numberget

Number Masking API

Getting started with Number Masking
How to implement 8x8 Number Masking?
Webhooks API
Call Status (Number Masking)
Call Action Handling (Number Masking)
Session Summary (Number Masking)
Error Codes (Number Masking)
Virtual Number Updated
Call Recordings

Video Interaction API

Introduction
Management API
- Token creationpost
Getting Started
Reporting API
Token example creation
iframe integration

Number Lookup API

Getting started with Number Lookup API
Number Lookup API
- Get phone number lookup dataget
Number Lookup Error Codes

Automation API

Getting started with Automation API
Workflow Definition Management
Workflow Instance Management
Workflow Triggers
- Trigger workflows using an external eventpost
Miscellaneous

Contacts API

Getting started with Contacts API
Contacts API
Groups API
Batch API

General API information

API Error codes
Message status reference
Price object reference
Webhook object structure
Security
IP address list

SMPP

SMPP - Connection
SMPP TLVs
SMPP - Delivery receipts
SMPP - Data encoding

Retrieve message details

get https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages/{umid}

This resource can be used to query message details like delivery status using the UMID of the message. You need to specify the sub account id and the umid of the message in place of {subAccountId} and {umid} respectively. umid is the unique identifier (in the form of a uuid) you received when you submitted the message to the api.

API Rate Limiting

To protect the platform from being overloaded and maintain a high quality of service to all customers, we enforce API rate limits for this API endpoint.

The limit is set to 1 request/second per subaccount.

URL Expired

The URL for this request expired after 30 days.

Path Params

subAccountId

string

required

length between 3 and 50

You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you signed up with a new account at https://connect.8x8.com.

umid

string

required

Unique message Id, generated by 8x8 API.

Responses

Response body

object

data

array of objects

required

data*

object

umid

string

required

Unique message ID automatically generated by 8x8.

subAccountId

string

required

Sub account id with which the message is associated with.

channel

string

required

Name of the channel used to send the message. Possible values are SMS, WhatsApp, RCS, Viber, Line, Facebook, WeChat, Zalo or Kakao.

channelId

string

required

Unique channel identifier. This property uniquely identifies the channel used to send the message when multiple channels of the same type are associated with one sub account.

direction

string

required

Direction of the message. Possible values are

outbound: Mobile terminated.
inbound: Mobile originated.

country

string

Two-letter ISO 3166 country code associated with the message.

status

object

required

Delivery status of the message. Status contains the following information.

user

object

Information about the user the message is associated with.

contentType

string

required

Content type of the message. Possible values are Text, Audio, Video, Image, Location, File, Carousel, List, Buttons or Template.

content

string

Message content (obfuscated to protect sensitive information).

createdAt

string

required

Date and time the message was submitted to the api expressed in ISO 8601 format.

clientMessageId

string

Client message identifier.

clientBatchId

string

Client batch identifier.

batchId

string

Universaly unique batch identifier (UUID).

step

integer

required

Indicates the attempt on which the channel was used. For instance, a message delivery may be failed via Viber and a fallback channel like WhatsApp may be attempted next. In this case, step 1 will contain message details for Viber and step 2 will contain the message details for WhatsApp.

Response body

object

code

integer

required

Error code

message

string

Error description

errorId

uuid

required

Unique id of error. You can use it as reference when sending enquiries to 8x8 support

timestamp

date-time

required

Data and time of the error occurence

Response body

object

code

integer

required

Error code

message

string

Error description

errorId

uuid

required

Unique id of error. You can use it as reference when sending enquiries to 8x8 support

timestamp

date-time

required

Data and time of the error occurence

Response body

object

code

integer

required

Error code

message

string

Error description

errorId

uuid

required

Unique id of error. You can use it as reference when sending enquiries to 8x8 support

timestamp

date-time

required

Data and time of the error occurence

Response body

object

code

integer

required

Error code

message

string

Error description

errorId

uuid

required

Unique id of error. You can use it as reference when sending enquiries to 8x8 support

timestamp

date-time

required

Data and time of the error occurence

Updated over 1 year ago

Cancel the log export job

Webhook Configuration API

Did this page help you?

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://chatapps.8x8.com/api/v1/subaccounts/subAccountId/messages/umid \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Cancel the log export job

Webhook Configuration API

Did this page help you?

SMS API
Getting started with SMS API
Send SMS API
Cancel the scheduled SMSdelete
SMS Success Feedbackpost
Cancel batch of scheduled SMSdelete
Send SMS batchpost
Send SMSpost
Reporting API
Get account balanceget
Get SMS price listget
Remove Personally Identifiable Information (PII)delete
Retrieve SMS detailsget
Cancel the log export jobdelete
Get log export job resultget
Start SMS log export jobpost
Engage API
Send SMS Engage surveys as batchpost
Send SMS Engage surveypost
Webhook Configuration API
Delete webhooksdelete
Create or Replace webhookspost
Get all Webhooks for Accountget
SMS Callbacks Reference
SMS Engage response webhook
Delivery receipts for outbound SMS
Inbound SMS
SMS Delivery receipts error codes

Business Messaging API
Getting started with Messaging API
Send Message API
Cancel batch of scheduled messagedelete
Cancel the scheduled messagedelete
Send Line Notification message batchpost
Send Line Notification messagepost
Send message batchpost
Send messagepost
Supported Messaging Apps
Supported Messaging Apps Content Types
Management API
Remove WhatsApp templatedelete
Add WhatsApp templatepost
Get WhatsApp templatesget
Mark message as readpost
Reporting API
Retrieve message detailsget
Cancel the log export jobdelete
Get log export job resultget
Start log export jobpost
Download Messaging Apps Logs
Webhook Configuration API
Delete webhooksdelete
Create or Replace webhookspost
Get all Webhooks for Accountget
Messaging Apps Callbacks Reference
WhatsApp Template Change Webhook
Delivery receipts for outbound Chat Apps
Inbound Messaging Apps message
Messaging Apps Fallback management
Delivery Error Codes

Verification API
Getting started with Verification API
Verification API
SMA coverage checkpost
Validate verificationget
Initiate verificationpost

Voice V1 API
Voice Messaging
Getting started with Voice API
Voice Messaging
Session Summary (Voice Messaging)
Voice Messaging Guide
Send Single Voice Message playFile (Audio File)
Send Single Voice Message TTS
Send Callflowpost
IVR
IVR Samples
Advanced IVR (Reservation Example)
Simple IVR
Webhook Setup Guide for IVR
Callflow Actions
Send Callflowpost
Voice Profile API
Get speech profiles for your accountget
Webhooks API
Delete a specific type of webhookdelete
Create a new webhookpost
Get webhook information for your accountget
Voice Call Action Webhook
Call Action Handling (IVR)
Error Code ( Voice Messaging & IVR)
Status Code and Status Message (Voice Messaging & IVR)
Recording API
Get recording statusget
Delete recording push configdelete
Create a new recording push configpost
Get recording push config for your accountget
Virtual Number Management API
Check Virtual Numberget
Get My Virtual Numbersget

Number Masking API
Getting started with Number Masking
How to implement 8x8 Number Masking?
Webhooks API
Webhook Setup Guide for IVR
Delete a specific type of webhookdelete
Create a new webhookpost
Get webhook information for your accountget
Call Status (Number Masking)
Call Action Handling (Number Masking)
Session Summary (Number Masking)
Error Codes (Number Masking)
Virtual Number Updated
Call Recordings

Video Interaction API
Introduction
Management API
Token creationpost
Getting Started
Reporting API
Retrieve Imageget
Detail callget
Call Logsget
Token example creation
iframe integration

Number Lookup API
Getting started with Number Lookup API
Number Lookup API
Get phone number lookup dataget
Number Lookup Error Codes

Automation API
Getting started with Automation API
Examples
Time zone & Onboarding
Context & Scripting
Branches
Triggers & Steps
Workflow Definition Management
Test workflow definitionpost
Delete workflow definitiondelete
Update workflow definitionput
Retrieve the version history of a workflow definition.get
Create a new workflow definitionpost
Retrieve a list of active workflow definitions.get
Workflow Instance Management
Retrieve a list of errors for a workflow instanceget
Update workflow instance statuspatch
Retrieve workflow instance statusget
Retrieve a list of workflow instancesget
Workflow Triggers
Trigger workflows using an external eventpost
Miscellaneous
Retrieve a list of executed workflow counts by yearlyget
Retrieve the allowed workflow counts and current usageget
Retrieve a list of supported JavaScript functionsget
Retrieve a list of supported time zonesget

Contacts API
Getting started with Contacts API
Contacts API
Update contact informationpatch
Delete single contactdelete
Get contact information by idget
Create contactpost
Search contactsget
Groups API
Remove contacts from a groupdelete
Add a contact to a grouppost
Update group informationpatch
Delete groupdelete
Get group information by idget
Create a grouppost
Search for groupsget
Batch API
Get batch job listget
Get batch information by idget
Batch delete groupspost
Move contacts between groupspost
Copy contacts between groupspost
Batch delete contactspost
Batch create contactspost

General API information
API Error codes
Message status reference
Price object reference
Webhook object structure
Security
IP address list

SMPP
SMPP - Connection
SMPP TLVs
SMPP - Delivery receipts
SMPP - Data encoding

SMS API
Getting started with SMS API
Send SMS API
Cancel the scheduled SMSdelete
SMS Success Feedbackpost
Cancel batch of scheduled SMSdelete
Send SMS batchpost
Send SMSpost
Reporting API
Get account balanceget
Get SMS price listget
Remove Personally Identifiable Information (PII)delete
Retrieve SMS detailsget
Cancel the log export jobdelete
Get log export job resultget
Start SMS log export jobpost
Engage API
Send SMS Engage surveys as batchpost
Send SMS Engage surveypost
Webhook Configuration API
Delete webhooksdelete
Create or Replace webhookspost
Get all Webhooks for Accountget
SMS Callbacks Reference
SMS Engage response webhook
Delivery receipts for outbound SMS
Inbound SMS
SMS Delivery receipts error codes

Business Messaging API
Getting started with Messaging API
Send Message API
Cancel batch of scheduled messagedelete
Cancel the scheduled messagedelete
Send Line Notification message batchpost
Send Line Notification messagepost
Send message batchpost
Send messagepost
Supported Messaging Apps
Supported Messaging Apps Content Types
Management API
Remove WhatsApp templatedelete
Add WhatsApp templatepost
Get WhatsApp templatesget
Mark message as readpost
Reporting API
Retrieve message detailsget
Cancel the log export jobdelete
Get log export job resultget
Start log export jobpost
Download Messaging Apps Logs
Webhook Configuration API
Delete webhooksdelete
Create or Replace webhookspost
Get all Webhooks for Accountget
Messaging Apps Callbacks Reference
WhatsApp Template Change Webhook
Delivery receipts for outbound Chat Apps
Inbound Messaging Apps message
Messaging Apps Fallback management
Delivery Error Codes

Verification API
Getting started with Verification API
Verification API
SMA coverage checkpost
Validate verificationget
Initiate verificationpost

Voice V1 API
Voice Messaging
Getting started with Voice API
Voice Messaging
Session Summary (Voice Messaging)
Voice Messaging Guide
Send Single Voice Message playFile (Audio File)
Send Single Voice Message TTS
Send Callflowpost
IVR
IVR Samples
Advanced IVR (Reservation Example)
Simple IVR
Webhook Setup Guide for IVR
Callflow Actions
Send Callflowpost
Voice Profile API
Get speech profiles for your accountget
Webhooks API
Delete a specific type of webhookdelete
Create a new webhookpost
Get webhook information for your accountget
Voice Call Action Webhook
Call Action Handling (IVR)
Error Code ( Voice Messaging & IVR)
Status Code and Status Message (Voice Messaging & IVR)
Recording API
Get recording statusget
Delete recording push configdelete
Create a new recording push configpost
Get recording push config for your accountget
Virtual Number Management API
Check Virtual Numberget
Get My Virtual Numbersget

Number Masking API
Getting started with Number Masking
How to implement 8x8 Number Masking?
Webhooks API
Webhook Setup Guide for IVR
Delete a specific type of webhookdelete
Create a new webhookpost
Get webhook information for your accountget
Call Status (Number Masking)
Call Action Handling (Number Masking)
Session Summary (Number Masking)
Error Codes (Number Masking)
Virtual Number Updated
Call Recordings

Video Interaction API
Introduction
Management API
Token creationpost
Getting Started
Reporting API
Retrieve Imageget
Detail callget
Call Logsget
Token example creation
iframe integration

Number Lookup API
Getting started with Number Lookup API
Number Lookup API
Get phone number lookup dataget
Number Lookup Error Codes

Automation API
Getting started with Automation API
Examples
Time zone & Onboarding
Context & Scripting
Branches
Triggers & Steps
Workflow Definition Management
Test workflow definitionpost
Delete workflow definitiondelete
Update workflow definitionput
Retrieve the version history of a workflow definition.get
Create a new workflow definitionpost
Retrieve a list of active workflow definitions.get
Workflow Instance Management
Retrieve a list of errors for a workflow instanceget
Update workflow instance statuspatch
Retrieve workflow instance statusget
Retrieve a list of workflow instancesget
Workflow Triggers
Trigger workflows using an external eventpost
Miscellaneous
Retrieve a list of executed workflow counts by yearlyget
Retrieve the allowed workflow counts and current usageget
Retrieve a list of supported JavaScript functionsget
Retrieve a list of supported time zonesget

Contacts API
Getting started with Contacts API
Contacts API
Update contact informationpatch
Delete single contactdelete
Get contact information by idget
Create contactpost
Search contactsget
Groups API
Remove contacts from a groupdelete
Add a contact to a grouppost
Update group informationpatch
Delete groupdelete
Get group information by idget
Create a grouppost
Search for groupsget
Batch API
Get batch job listget
Get batch information by idget
Batch delete groupspost
Move contacts between groupspost
Copy contacts between groupspost
Batch delete contactspost
Batch create contactspost

General API information
API Error codes
Message status reference
Price object reference
Webhook object structure
Security
IP address list

SMPP
SMPP - Connection
SMPP TLVs
SMPP - Delivery receipts
SMPP - Data encoding

200The success response returned with the message details of the message specified by the umid. Since channel fallback is supported, a single message umid may have multiple message details records depending on the number of channels attempted.

400Bad request error response

401Request was not authenticated response

404The entity doesn't exist

429Rate limiting quota exceeded error