How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SMS API

8x8 Connect SMS API for single and batch A2P SMS delivery worldwide, with sender ID handling, encoding control, delivery receipts and message status lookup.

SMS API is one of 36 APIs that 8x8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CPaaS, SMS, Messaging, and A2P. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 17 operations across 13 paths, organized into 4 resource areas, and defines 22 schemas. It is described by OpenAPI 3.0.1, at version 1.

Requests are made against 4 base URLs: https://sms.8x8.com, https://sms.us.8x8.com, https://sms.8x8.uk, https://sms.8x8.id.

17 operations 13 paths 22 schemas 5 DELETE5 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1
Base URL
https://sms.8x8.com
Authentication
HTTP Bearer
Contact
Terms of Service
Resource Areas
4

Authentication & Security 1

SMS API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiKey). By default, every request must be authenticated.

  • apiKey — 8x8 SMS API accepts an ApiKey Bearer Token authentication method. You can generate tokens from your customer portal [https://connect.8x8.com/](https://connect.…

Paths & Operations 17

Across 13 paths, the API surfaces 17 operations — 5 DELETE, 5 GET, 7 POST. They span 4 resource areas: Send SMS API, Engage API, Reporting API, Webhook Configuration API. Each is listed below with its method, path, parameters, and response codes.

Send SMS API 5
POST
/api/v1/subaccounts/{subAccountId}/messages
Send SMS
Send-Sms-Single 1 param body → 200400401500426
POST
/api/v1/subaccounts/{subAccountId}/messages/batch
Send SMS batch
Send-Many-Sms 1 param body → 200400401500426
DELETE
/api/v1/subaccounts/{subAccountId}/messages/batch/{batchId}
Cancel batch of scheduled SMS
cancel-many-sms-messages 2 params → 200400401500426
POST
/api/v1/subaccounts/{subAccountId}/messages/{umid}/feedback
SMS Success Feedback
api-Sms-Feedback 2 params body → 200400401500
DELETE
/api/v1/subaccounts/{subAccountId}/messages/{umid}
Cancel the scheduled SMS
cancel-scheduled-message 2 params → 200400401404426
Engage API 2
POST
/api/v1/subaccounts/{subAccountId}/surveys/{surveyId}/messages
Send SMS Engage survey
Survey-Send 2 params body → 200400401500
POST
/api/v1/subaccounts/{subAccountId}/surveys/{surveyId}/messages/batch
Send SMS Engage surveys as batch
Survey-Send-Many 3 params body → 200400401500
Reporting API 7
POST
/api/v1/subaccounts/{subAccountId}/messages/exports
Start SMS log export job
start-log-export-job 1 param body → 202
GET
/api/v1/subaccounts/{subAccountId}/messages/exports/{jobId}
Get log export job result
get-log-export-job-result 2 params → 200404
DELETE
/api/v1/subaccounts/{subAccountId}/messages/exports/{jobId}
Cancel the log export job
cancel-log-export-job 2 params → 204404
GET
/api/v1/subaccounts/{subAccountId}/messages/{umid}
Retrieve SMS details
get-sms-message-details 2 params → 200400401404429
DELETE
/api/v1/subaccounts/{subAccountId}/messages/{umid}/pii
Remove Personally Identifiable Information (PII)
delete-pii 2 params → 202404429500
GET
/api/v1/accounts/{accountId}/prices
Get SMS price list
get-price-list 6 params → 200400401429500426
GET
/api/v1/accounts/{accountId}/balance
Get account balance
get-account-balance 1 param → 200403429500
Webhook Configuration API 3
GET
/api/v1/accounts/{accountId}/webhooks
Get all Webhooks for Account
Get-Webhooks-2 1 param → 200400401500
POST
/api/v1/accounts/{accountId}/webhooks
Create or Replace webhooks
Add-Webhooks-2 1 param body → 200400401500
DELETE
/api/v1/accounts/{accountId}/webhooks
Delete webhooks
Delete-Webhooks-2 1 param body → 200400401500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SmsRequest (11 properties), SurveyRequest (10 properties), SmsTemplateFull (6 properties), BatchSmsRequest (6 properties). Each schema is shown below with its type and property counts.

SmsRequest
object
Request object to send one SMS
11 properties 2 required
SmsResponse
object
Response object of sending one SMS
5 properties 4 required
SmsStatus
object
2 properties 2 required
BatchSmsRequest
object
Request object to send batch of SMS
6 properties 1 required
SmsTemplateFull
object
6 properties
BatchSmsResponse
object
Response object of sending batch of SMS
5 properties 3 required
SurveyRequest
object
10 properties 1 required
SurveyTemplate
object
6 properties 1 required
BatchSurveyRequest
object
4 properties 1 required
feedback
object
2 properties 1 required
PriceSubAccounts
object
3 properties
PriceHni
object
2 properties
PriceOutboundCountry
object
4 properties
PriceOutboundOperator
object
4 properties
Price
object
Price
2 properties
PriceOutbound
object
1 property
PriceInboundNumber
object
2 properties
PriceInbountCountry
object
4 properties
LogExportRequest
object
5 properties
LogExportJobStatus
object
3 properties
AccountBalance
object
2 properties
country
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

8x8-connect-sms-api.json Raw ↑

Other APIs 8x8 publishes across the network.

8x8 Contact Center Chat API V2
8x8 Contact Center Dynamic Campaigns
Contact Center Campaigns API
Chapi - Chat API
Contact Center Agent Status API
8x8 Contact Center Call API Reference
Contact Center Chat Gateway
8x8 Administration - Address Management API
8x8 Administration - Operations API
8x8 Administration - Phone Number Management API
8x8 Administration - Ring Group Management API
8x8 Administration - Site Management API
Where this information came from

This is an independent, third-party profile of SMS API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.