> ## Documentation Index
> Fetch the complete documentation index at: https://developers.phonovation.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get outbound SMS message logs
> Use this method to obtain the logs associated with outbound messages. The available logs are limited to those generated in the last 48 hours, and you can retrieve a maximum of only 1000 logs per call. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports-v3) if your use case is to verify message delivery.
**Required scope:** Enable one of: `sms:manage`, `sms:logs:read`.
## OpenAPI
````yaml /openapi/phonovation-whatsapp.json get /sms/3/logs
openapi: 3.1.0
info:
title: Phonovation Messaging APIs
description: >-
OpenAPI specification for Phonovation messaging, customer engagement, and
platform APIs.
contact:
name: Phonovation support
email: support@phonovation.com
version: 3.250.0
x-generatedAt: '2026-10-15T11:28:56.135064395Z'
servers:
- url: https://api.messaging.phonovation.com
description: Phonovation Messaging API production server
security: []
tags:
- name: customer-engagement
description: >
Complete solutions that will help you drive better outcomes for your
customers and business across the entire customer journey.
x-type: category
x-displayName: Customer Engagement
- name: people
description: >
Build rich profiles for each person to create audience segments for more
precise targeting. Manage duplicates and import your data over API.
Events reflect actions that end users take on your website or in your
mobile application.
Events API is a robust way to send those events to Phonovation. Event can
be sent only to an existing person in People module and an event
definition should be created beforehand to describe contents of the event.
Other events tracking options:
* [ JavaScript SDK ](https://github.com/phonovation/people-web-sdk)
* [iOS
SDK](https://github.com/phonovation/mobile-messaging-sdk-ios/wiki/Events)
* [Android
SDK](https://github.com/phonovation/mobile-messaging-sdk-android/wiki/Events)
x-type: product
x-displayName: People
- name: person-profile
description: ''
x-type: section
x-displayName: Person profile
- name: company-profile
description: ''
x-type: section
x-displayName: Company profile
- name: tags
description: ''
x-type: section
x-displayName: Tags
- name: custom-attributes
description: ''
x-type: section
x-displayName: Custom attributes
- name: custom-attributes-lists
description: ''
x-type: section
x-displayName: 'Custom attributes: Lists'
- name: contact-information:-push
description: ''
x-type: section
x-displayName: 'Contact Information: Push'
- name: events
description: ''
x-type: section
x-displayName: Events
- name: segments
description: ''
x-type: section
x-displayName: Segments
- name: moments
description: >
Use Moments to set up and manage automated messaging campaigns with your
customers by building conversation workflows.
x-type: product
x-displayName: Moments
- name: flow
description: >
[Flow](https://www.phonovation.com/docs/moments/manage-flow) is the
Phonovation communication builder that helps you create and manage
messaging campaigns. The Flows API allows you to add or remove people from
communication programmatically for flows with an [active
status](https://www.phonovation.com/docs/moments/manage-flow#launch-create).
Use the Add Participants to flow endpoint to a person or batches of
persons (between 1-1000 persons). The method works asynchronously to queue
and process participants at a rate of 10 requests per second. For
reporting of operation results, use the notifyUrl field to provide a URL
of your callback server that will receive a status report or use the Get a
report on participants added to Flow endpoint.
x-type: module
x-displayName: Flow
- name: conversations
description: >-
Conversations is a solution that allows Enterprises to engage in
conversations with their customers over multiple channels. The solution is
available either as a web-based cloud platform web interface or over HTTP
API for 2-way messaging over SMS, WhatsApp, Viber, and Facebook messenger.
It supports conversation threading, conversation management including
queues and routing, agent assignment, resolution management and
conversation history overview.
x-type: product
x-displayName: Conversations
- name: conversation-management
description: ''
x-type: section
x-displayName: Conversation management
- name: conversation-tags
description: ''
x-type: section
x-displayName: Conversation tags
- name: conversation-messages
description: ''
x-type: section
x-displayName: Conversation messages
- name: conversation-events
description: ''
x-type: section
x-displayName: Conversation events
- name: conversation-notes
description: ''
x-type: section
x-displayName: Conversation notes
- name: conversation-agents
description: ''
x-type: section
x-displayName: Conversation agents
- name: conversation-queues
description: ''
x-type: section
x-displayName: Conversation queues
- name: conversation-routing
description: ''
x-type: section
x-displayName: Conversation routing
- name: bots
description: ''
x-type: section
x-displayName: Bots
- name: metadata
description: ''
x-type: section
x-displayName: Metadata
- name: templates
description: ''
x-type: section
x-displayName: Templates
- name: conversation-forms
description: ''
x-type: section
x-displayName: Conversation forms
- name: account-configuration
description: ''
x-type: section
x-displayName: Account Configuration
- name: agent-configuration-calls
description: ''
x-type: section
x-displayName: Agent Configuration (Calls)
- name: outbound-call-conversation-calls
description: ''
x-type: section
x-displayName: Outbound Call Conversation (Calls)
- name: waiting-strategies-calls
description: ''
x-type: section
x-displayName: Waiting Strategies (Calls)
- name: recording-configuration-calls
description: ''
x-type: section
x-displayName: Recording Configuration (Calls)
- name: recording-metadata-calls
description: ''
x-type: section
x-displayName: Recording metadata (Calls)
- name: recording-calls
description: ''
x-type: section
x-displayName: Recording (Calls)
- name: wrap-up-configuration-calls
description: ''
x-type: section
x-displayName: Wrap Up Configuration (Calls)
- name: wrap-up-time-calls
description: ''
x-type: section
x-displayName: Wrap Up Time (Calls)
- name: transfers-calls
description: ''
x-type: section
x-displayName: Transfers (Calls)
- name: transfer-to-external-number-configuration-calls
description: ''
x-type: section
x-displayName: Transfer to External Number Configuration (Calls)
- name: transfer-strategy-calls
description: ''
x-type: section
x-displayName: Transfer Strategy (Calls)
- name: call-hold-calls
description: ''
x-type: section
x-displayName: Call Hold (Calls)
- name: hold-configuration-calls
description: ''
x-type: section
x-displayName: Hold Configuration (Calls)
- name: call-timeout-calls
description: ''
x-type: section
x-displayName: Call Timeout (Calls)
- name: working-hours
description: ''
x-type: section
x-displayName: Working Hours
- name: tts-options-calls
description: ''
x-type: section
x-displayName: TTS options (Calls)
- name: away-audio-messages
description: ''
x-type: section
x-displayName: Away Audio Messages
- name: web-forms
description: ''
x-type: section
x-displayName: Web Forms
- name: answers
description: >
Answers is the Phonovation fully-encompassed chatbot building platform
that enables you to build, test, and deploy highly customized chatbots of
different types. Multiple channels are supported on Answers like WhatsApp,
Facebook Messenger, Live Chat, Apple Business Chat, Viber, Google Business
Messaging and other. Communication with Bot is achieved through existing
Conversations solution infrastructure which enables integration and
switching between communicating with bot and a live agent. Processing can
start by receiving MO message or by receiving a trigger event. Users can
manage bots (create, update, delete, start and stop bots) through a web
interface. For more details, visit the [Answers
documentation](https://www.phonovation.com/docs/answers).
Answers API is in Early access stage.
x-type: product
x-displayName: Answers
- name: answers-testing-start-test
description: ''
x-type: section
x-displayName: Start Answers test
- name: answers-testing-stop-test
description: ''
x-type: section
x-displayName: Stop Answers test
- name: answers-testing-send-message
description: ''
x-type: section
x-displayName: Send inbound message to test
- name: common-assets
description: >
Reuse assets created on Phonovation SaaS products in order to recreate
configuration more easily on a single or across multiple accounts. Export
or share Moments flows, Answers chatbots or other SaaS assets from your
account and import it on another one.
This feature is in Early access stage.
x-type: product
x-displayName: Common Assets
- name: saas-resource-export
description: ''
x-type: section
x-displayName: Export resource
- name: saas-resource-import
description: ''
x-type: section
x-displayName: Import resource
- name: saas-resource-share
description: ''
x-type: section
x-displayName: Share resource
- name: saas-status-request
description: ''
x-type: section
x-displayName: Get SaaS request status
- name: knowledge-base
description: >-
Knowledge Base is a centralized content management system for creating,
organizing, and retrieving articles, attachments, and structured content.
Content is organized into categories, folders, and a hierarchical content
tree. Articles support draft and published workflow statuses, tagging,
commenting, and file attachments.
x-type: product
x-displayName: Knowledge Base
- name: knowledge-base-search
description: ''
x-type: section
x-displayName: Search
- name: knowledge-base-articles
description: ''
x-type: section
x-displayName: Articles
- name: knowledge-base-categories
description: ''
x-type: section
x-displayName: Categories
- name: knowledge-base-folders
description: ''
x-type: section
x-displayName: Folders
- name: knowledge-base-content-tree
description: ''
x-type: section
x-displayName: Content Tree
- name: knowledge-base-tags
description: ''
x-type: section
x-displayName: Tags
- name: knowledge-base-attachments
description: ''
x-type: section
x-displayName: Attachments
- name: ai-hub
description: >
AI-powered tools and services to help you create smarter and more
personalized customer experiences.
x-type: category
x-displayName: AI Hub
- name: ai-assistants
description: >
Phonovation AI assistant is a retrieval-augmented generation (RAG)
solution that performs tasks based on documents and
instructions you specify. This means the AI draws answers directly from
your documents, resulting in more accurate
and relevant responses. For more information on use cases and how to build
AI assistants, visit our
[AI Assistant](https://www.phonovation.com/docs/ai-hub/ai-assistant)
product documentation.
With AI Assistants API, you can:
* Query your existing AI assistants created via [Phonovation
Portal](https://www.phonovation.com/docs/ai-hub/ai-assistant/create-ai-assistant)
* Retrieve context the AI assistant uses to answer your queries
x-type: product
x-displayName: AI Assistants
- name: channels
description: >
Create a perfect customer experience by using the channels your customer
already use and love.
x-type: category
x-displayName: Channels
- name: sms
description: >
SMS (Short Message Service) is the most extensive messaging service
available in terms of reach and coverage. A SMS can be sent to and from
any mobile device in the world and does not necessarily require a data
connection.
Phonovation SMS API allows you to send and receive text messages (SMS),
fetch or receive delivery reports on your endpoint in real time, and see
message logs. You can send messages in different languages, schedule your
messages, define delivery time window, and much more.
To utilize SMS in combination with other channels, check out [Messages
API](https://www.phonovation.com/docs/api/platform/messages-api).
x-type: product
x-displayName: SMS
- name: outbound-sms
description: >
When you send an SMS to a phone number belonging to an end user's device
you are sending an Outbound SMS. Historically, this was and still is
referred to as a Mobile Terminated (MT) SMS, though nowadays an SMS is not
always sent to a mobile device. In an Outbound SMS you can set the From or
Sender field with whatever you have registered or purchased with
Phonovation, either a Long Number, Short Code, or text based Sender.
x-type: module
x-displayName: Outbound SMS
- name: send-message
description: ''
x-type: section
x-displayName: Send a message
- name: manage-scheduled-sms-messages
description: ''
x-type: section
x-displayName: Manage Scheduled SMS Messages
- name: confirm-conversion
description: ''
x-type: section
x-displayName: Confirm conversion
- name: inbound-sms
description: >
When an end user sends an SMS from their device to a Phone Number or Short
Code they have sent an Inbound SMS. The Inbound SMS is routed to the
Phonovation Platform and Phonovation in turn routes the SMS to its
Customer who has purchased that Phone Number or Short Code. Inbound SMS,
for historical reasons, are referred to as Mobile Originated (MO) SMS.
x-type: module
x-displayName: Inbound SMS
- name: logs-and-status-reports
description: >
Status Reports tell you what happened to the SMS you sent, whether it was
successfully delivered or failed to be delivered.
They also provide timestamps, network information if available, and on SMS
delivery failure, a status code indicating the reason.
Status Reports can be pushed in real-time to a Customer's webhook or can
be retrieved by an API call.
Logs provide similar information to Status Reports but are available to
query for 48hrs.
x-type: module
x-displayName: Logs and Status Reports
- name: whatsapp
description: >
With 2 billion users, WhatsApp is the most used application worldwide. It
enables you to reach more customers, sharing important and timely
notifications, as well as provide real-time customer support. Phonovation
is an official WhatsApp Business solution provider. Send and manage
WhatsApp messages over Phonovation's WhatsApp API.
To utilize WhatsApp in combination with other channels, check out
[Messages
API](https://www.phonovation.com/docs/api/platform/messages-api).
[Learn more about WhatsApp channel and use
cases](https://www.phonovation.com/docs/whatsapp).
x-type: product
x-displayName: WhatsApp
- name: whatsapp-outbound-messages
description: >
When you send a WhatsApp message to a phone number belonging to an end
user's device you are sending an outbound WhatsApp message.
There are several types of WhatsApp messages:
- Template message – use a pre-defined template to send text, images, videos, share location, documents, attach buttons, and configure SMS failover.
- Free-form text or media – use it only when contacted by the end user within a certain timeframe to send text, images, audio, video, stickers, share location, or contacts.
- Interactive messages – send a message that your end user can interact with, such as interactive buttons, lists, or product messages.
x-type: module
x-displayName: Outbound messages
- name: whatsapp-template-message
description: ''
x-type: section
x-displayName: Template Message
- name: whatsapp-text-and-media-messages
description: ''
x-type: section
x-displayName: Text and media messages
- name: send-whatsapp-interactive-messages
description: ''
x-type: section
x-displayName: Interactive messages
- name: whatsapp-events
description: ''
x-type: section
x-displayName: Events
- name: whatsapp-inbound-messages
description: >
When the end user sends a WhatsApp from their device to a phone number,
they have sent an inbound WhatsApp message.
The inbound message is routed to the Phonovation Platform and Phonovation
in turn routes the message to its customer who has registered the WhatsApp
sender.
Typical supporting features you’d use with inbound messages are:
- Marking messages as read to communicate to the end user that you have read their message.
- Downloading media and its metadata sent over by the end user.
x-type: module
x-displayName: Inbound messages
- name: whatsapp-receive-inbound-message
description: ''
x-type: section
x-displayName: Receive inbound message
- name: whatsapp-get-inbound-media
description: ''
x-type: section
x-displayName: Get inbound media
- name: whatsapp-mark-message-as-read
description: ''
x-type: section
x-displayName: Mark message as read
- name: whatsapp-message-status-reports
description: >
Status Reports tell you what happened to the WhatsApp message you sent,
whether it was successfully delivered or failed to be delivered, whether
it’s been seen.
Status Reports can be pushed in real time to a customer's webhook or can
be retrieved by an API call.
Logs provide similar information to Status Reports but are only available
to query for 48hrs.
There are a few reports you can set up for your WhatsApp messaging:
- Delivery Reports - In case of a failure, you’ll receive a timestamp with a delivery failure message and a status code indicating the reason behind it.
- Seen Reports – In case the message has been delivered successfully to the end user, this report will additionally inform you whether the message has been seen.
- Payments - It provides all updates to your payment transaction in real time. It's also possible to fetch current state of the payment transaction in any time.
x-type: module
x-displayName: Message Status Reports
- name: whatsapp-status-reports
description: ''
x-type: section
x-displayName: Status Reports
- name: whatsapp-payments
description: ''
x-type: section
x-displayName: Payments
- name: whatsapp-marketing-update
description: ''
x-type: section
x-displayName: Marketing Update
- name: whatsapp-service-management
description: >
As opposed to free-form messages, template messages can be sent and
delivered at any time.
Here, you can manage your templates, from template registration,
retrieving template statuses, to deleting existing templates.
With each WhatsApp message, you can send various types of media. Here, you
can manage your media and configure additional feature enhancing their
functionality.
Moreover you can fetch quality and business info of your senders.
x-type: module
x-displayName: Service Management
- name: whatsapp-template-management
description: ''
x-type: section
x-displayName: Template Management
- name: whatsapp-flow-management
description: ''
x-type: section
x-displayName: Flow Management
- name: whatsapp-media-management
description: ''
x-type: section
x-displayName: Media Management
- name: whatsapp-sender-management
description: ''
x-type: section
x-displayName: Sender Management
- name: whatsapp-bulk-sender-registration
description: ''
x-type: section
x-displayName: Bulk Sender Registration
- name: whatsapp-identity-management
description: >
Set up identity change, an add-on available for senders hosted by
Phonovation. This is supported for interactive buttons, interactive lists,
or an interactive product message.
Identity change allows you to increase your security by preventing
messages from being sent to unverified end users.
Once enabled for a sender, you would receive notifications when an end
user's WhatsApp account (MSISDN) has potentially been transferred to a
different user.
When a potential identity change has been detected, the outbound traffic
towards that end user is blocked until you verify the user outside the
channel and acknowledge the change.
Contact your Account Executive for more information.
x-type: module
x-displayName: Identity Management
- name: whatsapp-ad-conversions
description: >
The Conversions API for Business Messaging enables advertisers to
consolidate web, app, physical store, and business messaging events into a
single endpoint for Meta. With Phonovation, you can submit Purchase or
LeadSubmitted conversion events for WhatsApp.
x-type: module
x-displayName: Ad Conversions
- name: platform
description: |
Modular tools to scale and automate your business.
x-type: category
x-displayName: Platform
- name: subscriptions-api
description: >
Subscriptions are a way to manage notifications sent to your webhooks by
Phonovation.
It is a useful feature if you want to narrow down the list of events to be
notified about or specify different webhooks for different use cases.
It will also allow you to set up authentication settings for your
endpoint.
If you want to use mutual TLS for the webhook that receives notification
events from Phonovation, you can upload and manage a TLS certificate that
Phonovation will use when connecting to your server. The certificate
allows your server to verify that the request is really coming from
Phonovation. For details, see [Create and Manage
Certificates](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/create-manage-subscriptions#create-and-manage-certificates).
x-type: product
x-displayName: Subscriptions Management
- name: subscription
description: ''
x-type: section
x-displayName: Subscription
- name: profile
description: ''
x-type: section
x-displayName: Profile
- name: security
description: ''
x-type: section
x-displayName: Security
- name: certificate
description: ''
x-type: section
x-displayName: Certificate
paths:
/sms/3/logs:
get:
tags:
- channels
- sms
- logs-and-status-reports
summary: Get outbound SMS message logs
description: >-
Use this method to obtain the logs associated with outbound messages.
The available logs are limited to those generated in the last 48 hours,
and you can retrieve a maximum of only 1000 logs per call. See [message
delivery
reports](#channels/sms/get-outbound-sms-message-delivery-reports-v3) if
your use case is to verify message delivery.
**Required scope:** Enable one of: `sms:manage`, `sms:logs:read`.
operationId: get-outbound-sms-message-logs-v3
parameters:
- name: mcc
in: query
description: Mobile Country Code.
required: false
style: form
explode: true
schema:
type: string
description: Mobile Country Code.
- name: mnc
in: query
description: >-
Mobile Network Code. Mobile Country Code is required if this
property is used.
required: false
style: form
explode: true
schema:
type: string
description: >-
Mobile Network Code. Mobile Country Code is required if this
property is used.
- name: sender
in: query
description: The sender ID which can be alphanumeric or numeric.
required: false
style: form
explode: true
schema:
type: string
- name: destination
in: query
description: Message destination address.
required: false
style: form
explode: true
schema:
type: string
- name: bulkId
in: query
description: >-
Unique ID assigned to the request if messaging multiple recipients
or sending multiple messages via a single API request. May contain
multiple comma-separated values. Maximum length 2048 characters.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
example: BULK-ID-123-xyz
- name: messageId
in: query
description: >-
Unique message ID for which a log is requested. May contain multiple
comma-separated values. Maximum length 2048 characters.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
- name: generalStatus
in: query
required: false
style: form
explode: true
schema:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageGeneralStatus
- name: sentSince
in: query
description: >-
The logs will only include messages sent after this date. Use it
alongside sentUntil to specify a time range for the logs, but only
up to the maximum limit of 1000 logs per call. Has the following
format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
required: false
style: form
explode: true
schema:
type: string
format: date-time
example: '2020-02-22T17:42:05.390+01:00'
- name: sentUntil
in: query
description: >-
The logs will only include messages sent before this date. Use it
alongside sentSince to specify a time range for the logs, but only
up to the maximum limit of 1000 logs per call. Has the following
format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
required: false
style: form
explode: true
schema:
type: string
format: date-time
description: >-
The logs will only include messages sent before this date. Use it
alongside sentSince to specify a time range for the logs, but only
up to the maximum limit of 1000 logs per call. Has the following
format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
example: '2020-02-23T17:42:05.39+01:00'
example: '2020-02-23T17:42:05.390+01:00'
- name: limit
in: query
description: >-
Maximum number of messages to include in logs. If not set, the
latest 50 records are returned. Maximum limit value is 1000 and you
can only access logs for the last 48h.
required: false
style: form
explode: true
schema:
type: integer
format: int32
default: 50
maximum: 1000
- name: entityId
in: query
description: >-
Entity id used to send the message. For more details, see our
[documentation](https://www.phonovation.com/docs/cpaas-x/application-and-entity-management).
required: false
style: form
explode: true
schema:
type: string
example: promotional-traffic-entity
- name: applicationId
in: query
description: >-
Application id used to send the message. For more details, see our
[documentation](https://www.phonovation.com/docs/cpaas-x/application-and-entity-management).
required: false
style: form
explode: true
schema:
type: string
example: marketing-automation-application
- name: campaignReferenceId
in: query
description: >-
ID of a campaign that was sent in the message. May contain multiple
comma-separated values.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
example: summersale
- name: useCursor
in: query
description: >-
Flag used to enable cursor-based pagination. When set to true, the
system will use the cursor to fetch the next set of logs.
required: false
style: form
explode: true
schema:
type: boolean
- name: cursor
in: query
description: >-
Value which represents the current position in the data set. For the
first request, this field shouldn't be defined. In subsequent
requests, use the `nextCursor` value returned from the previous
response to continue fetching data.
required: false
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent
examples:
Log:
summary: Log
value:
results:
- destination: '353861234579'
bulkId: BULK-ID-123-xyz
messageId: MESSAGE-ID-123-xyz
sentAt: 2019-11-09T16:00:00.000+0100
doneAt: 2019-11-09T16:00:00.000+0100
messageCount: 1
price:
pricePerMessage: 0.01
currency: EUR
status:
groupId: 3
groupName: DELIVERED
id: 5
name: DELIVERED_TO_HANDSET
description: Message delivered to handset
error:
groupId: 0
groupName: OK
id: 0
name: NO_ERROR
description: No Error
permanent: false
platform:
entityId: promotional-traffic-entity
applicationId: marketing-automation-application
content:
text: This is a sample message
mccMnc: '22801'
- destination: '353861234582'
bulkId: BULK-ID-123-xyz
messageId: 12db39c3-7822-4e72-a3ec-c87442c0ffc5
sentAt: 2019-11-09T17:00:00.000+0100
doneAt: 2019-11-09T17:00:00.000+0100
messageCount: 1
price:
pricePerMessage: 0.01
currency: EUR
status:
groupId: 3
groupName: DELIVERED
id: 5
name: DELIVERED_TO_HANDSET
description: Message delivered to handset
error:
groupId: 0
groupName: OK
id: 0
name: NO_ERROR
description: No Error
permanent: false
platform:
entityId: promotional-traffic-entity
applicationId: marketing-automation-application
content:
text: This is a sample message
mccMnc: '22801'
application/xml:
schema:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent
examples:
Log:
summary: Log
value: |
353861234579
BULK-ID-123-xyz
MESSAGE-ID-123-xyz
2019-11-09T16:00:00.000+0100
2019-11-09T16:00:00.000+0100
1
0.01
EUR
3
DELIVERED
5
DELIVERED_TO_HANDSET
Message delivered to handset
0
OK
0
NO_ERROR
No Error
false
promotional-traffic-entity
marketing-automation-application
This is a sample message
22801
353861234582
BULK-ID-123-xyz
12db39c3-7822-4e72-a3ec-c87442c0ffc5
2019-11-09T17:00:00.000+0100
2019-11-09T17:00:00.000+0100
1
0.01
EUR
3
DELIVERED
5
DELIVERED_TO_HANDSET
Message delivered to handset
0
OK
0
NO_ERROR
No Error
false
promotional-traffic-entity
marketing-automation-application
This is a sample message
22801
'401':
$ref: '#/components/responses/ApiError401'
'403':
$ref: '#/components/responses/ApiError403'
'429':
$ref: '#/components/responses/ApiError429'
'500':
$ref: '#/components/responses/ApiError500'
security:
- APIKeyHeader: []
externalDocs:
description: Learn more about the SMS channel and its use cases
url: https://www.phonovation.com/docs/sms
components:
schemas:
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageGeneralStatus:
type: string
description: >-
Status group name that describes which category the status code belongs
to, i.e.,
[PENDING](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes),
[UNDELIVERABLE](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes),
[DELIVERED](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes),
[EXPIRED](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes),
[REJECTED](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
enum:
- ACCEPTED
- PENDING
- UNDELIVERABLE
- DELIVERED
- EXPIRED
- REJECTED
title: MessageGeneralStatus
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent:
type: object
properties:
results:
type: array
description: >-
An array of message log results, one object per each message log
entry.
items:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLogSmsMessageContent
cursor:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.CursorPageInfo
title: LogResponseSmsLogSmsMessageContent
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLogSmsMessageContent:
type: object
description: An array of message log results, one object per each message log entry.
properties:
sender:
type: string
description: The sender ID which can be alphanumeric or numeric.
destination:
type: string
description: Message destination address.
bulkId:
type: string
description: >-
Unique ID assigned to the request if messaging multiple recipients
or sending multiple messages via a single API request.
example: BULK-ID-123-xyz
messageId:
type: string
description: Unique message ID for which a log is requested.
sentAt:
type: string
format: date-time
description: >-
Date and time when the message was sent. Has the following format:
yyyy-MM-dd'T'HH:mm:ss.SSSZ.
doneAt:
type: string
format: date-time
description: >-
Date and time when the Phonovation services finished processing the
message (i.e., delivered to the destination, network, etc.). Has the
following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.
messageCount:
type: integer
format: int32
description: The number of messages content was split to.
price:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessagePrice
status:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageStatus
error:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageError
platform:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform
content:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent
campaignReferenceId:
type: string
description: ID of a campaign that was sent in the message.
mccMnc:
type: string
description: Mobile country and network codes.
title: SmsLogSmsMessageContent
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.CursorPageInfo:
type: object
description: Cursor information.
properties:
limit:
type: integer
format: int32
description: Requested limit.
nextCursor:
type: string
description: >-
The `cursor` value you will use in your next request to fetch the
subsequent set of results.
readOnly: true
title: CursorPageInfo
ApiError:
type: object
properties:
errorCode:
type: string
description: An error code uniquely identifying the error case.
minLength: 1
description:
type: string
description: A detailed description of an error.
minLength: 1
action:
type: string
description: An action that should be taken to recover from the error.
minLength: 1
violations:
type: array
description: List of violations that caused the error.
items:
$ref: '#/components/schemas/ApiErrorViolation'
resources:
type: array
description: List of available resources to recover from the error.
items:
$ref: '#/components/schemas/ApiErrorResource'
required:
- action
- description
- errorCode
- resources
- violations
title: ApiError
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessagePrice:
type: object
description: Sent message price.
properties:
pricePerMessage:
type: number
description: Price per one message.
currency:
type: string
description: The currency in which the price is expressed.
title: MessagePrice
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageStatus:
type: object
description: >-
Indicates the
[status](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#api-status-codes)
of the message and how to recover from an error should there be any.
properties:
groupId:
type: integer
format: int32
description: Status group ID.
groupName:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageGeneralStatus
id:
type: integer
format: int32
description: Status code ID.
name:
type: string
description: >-
[Status
code](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#api-status-codes)
name.
description:
type: string
description: Human-readable description of the status.
action:
type: string
description: Action to take to recover from the error.
title: MessageStatus
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageError:
type: object
description: >-
Indicates whether an
[error](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#error-codes)
occurred during the query execution.
properties:
groupId:
type: integer
format: int32
description: Error group ID.
groupName:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageErrorGroup
id:
type: integer
format: int32
description: Error ID.
name:
type: string
description: >-
[Error
name](https://www.phonovation.com/docs/essentials/response-status-and-error-codes#error-codes).
description:
type: string
description: Human-readable description of the error.
permanent:
type: boolean
description: Indicates whether the error is recoverable or not.
title: MessageError
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform:
type: object
description: >-
Platform options. For more details, see
[documentation](https://www.phonovation.com/docs/cpaas-x/application-and-entity-management).
properties:
entityId:
type: string
description: >-
Used when specifying an entity in outbound send requests. It is also
returned in notification events. For detailed usage, refer to the
[documentation](https://www.phonovation.com/docs/cpaas-x/application-and-entity-management).
maxLength: 255
minLength: 0
applicationId:
type: string
description: >-
Used when specifying an application in outbound send requests. It is
also returned in notification events. For detailed usage, refer to
the
[documentation](https://www.phonovation.com/docs/cpaas-x/application-and-entity-management).
maxLength: 255
minLength: 0
title: Platform
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent:
type: object
description: Message content.
oneOf:
- $ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsTextMessageContent
- $ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsBinaryMessageContent
title: SmsMessageContent
ApiErrorViolation:
type: object
description: List of violations that caused the error.
properties:
property:
type: string
description: Request property that caused the error.
violation:
type: string
description: Detailed violation description.
title: ApiErrorViolation
ApiErrorResource:
type: object
description: List of available resources to recover from the error.
properties:
name:
type: string
description: Resource name.
url:
type: string
description: Resource URL.
title: ApiErrorResource
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageErrorGroup:
type: string
description: >-
Error group name that describes which category the error code belongs
to.
enum:
- OK
- HANDSET_ERRORS
- USER_ERRORS
- OPERATOR_ERRORS
title: MessageErrorGroup
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsTextMessageContent:
type: object
allOf:
- type: object
properties:
text:
type: string
description: Content of the message being sent.
minLength: 1
transliteration:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TransliterationCode
language:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLanguage
required:
- text
title: text content
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsBinaryMessageContent:
type: object
allOf:
- type: object
properties:
dataCoding:
type: integer
format: int32
default: 0
description: >-
Binary content data coding. The default value is (`0`) for GSM7.
Example: (`8`) for Unicode data.
example: 8
esmClass:
type: integer
format: int32
default: 0
description: >-
“Esm_class” parameter. Indicate special message attributes
associated with the SMS. Default value is (`0`).
hex:
type: string
description: >-
Hexadecimal string. This is the representation of your binary
data. Two hex digits represent one byte. They should be
separated by the space character.
example: 48 65 6c 6c 6f
minLength: 1
required:
- hex
title: binary content
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TransliterationCode:
type: string
description: >-
The transliteration of your sent message from one script to another.
[Transliteration](https://www.phonovation.com/docs/sms/language#sms-transliteration)
is used to replace characters which are not recognized as part of your
defaulted alphabet. `ALL` means that the transliteration process will
recognize all supported languages.
enum:
- NONE
- TURKISH
- GREEK
- CYRILLIC
- SERBIAN_CYRILLIC
- CENTRAL_EUROPEAN
- BALTIC
- NON_UNICODE
- PORTUGUESE
- COLOMBIAN
- BULGARIAN_CYRILLIC
- ALL
title: TransliterationCode
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLanguage:
type: object
description: Sets the language parameters for the message being sent.
properties:
languageCode:
$ref: >-
#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageCode
singleShift:
type: boolean
default: false
description: >-
Uses a single shift table which enhances only the extension table of
the GSM default alphabet. Allows you to selectively improve
character support without altering the entire message.
lockingShift:
type: boolean
default: false
description: >-
Uses a locking shift table which allows you to represent characters
beyond the standard GSM default alphabet. This flexibility enables
better language support.
title: SmsLanguage
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageCode:
type: string
description: >-
[Language
code](https://www.phonovation.com/docs/sms/language#national-language-identifier)
for the correct character set. `AUTODETECT` lets the platform select the
character set based on message content only for supported languages.
enum:
- NONE
- TR
- ES
- PT
- AUTODETECT
title: LanguageCode
responses:
ApiError401:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
errorCode: E401
description: >-
The request lacks valid authentication credentials for the
requested resource.
action: Check the resources and adjust authentication credentials.
violations: []
resources:
- name: API Authentication
url: https://www.phonovation.com/docs/essentials/api-authentication
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
example: |
E401
The request lacks valid authentication credentials for the requested resource.
Check the resources and adjust authentication credentials.
API Authentication
https://www.phonovation.com/docs/essentials/api-authentication
ApiError403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
errorCode: E403
description: Insufficient permissions to access the requested resource.
action: Repeat the request with new or different credentials.
violations: []
resources:
- name: API Scopes
url: >-
https://www.phonovation.com/docs/essentials/api-essentials/api-authorization#api-scopes
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
example: |
E403
Insufficient permissions to access the requested resource.
Repeat the request with new or different credentials.
API Scopes
https://www.phonovation.com/docs/essentials/api-essentials/api-authorization#api-scopes
ApiError429:
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
errorCode: E429
description: Too many requests sent.
action: >-
Check request rate limit specified in the API endpoint
documentation resource.
violations: []
resources:
- name: Throttling handling errors
url: >-
https://www.phonovation.com/docs/essentials/integration-best-practices#throttling-handling-errors
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
example: |
E429
Too many requests sent.
Check request rate limit specified in the API endpoint documentation resource.
Throttling handling errors
https://www.phonovation.com/docs/essentials/integration-best-practices#throttling-handling-errors
ApiError500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
errorCode: E500
description: Something went wrong.
action: Contact the support.
violations: []
resources: []
application/xml:
schema:
$ref: '#/components/schemas/ApiError'
example: |
E500
Something went wrong.
Contact the support.
securitySchemes:
APIKeyHeader:
type: apiKey
description: >
This is the most secure authorization type and the one with the most
flexibility.
API keys can be generated by calling the dedicated API method.
Furthermore, API keys can have a limited scope and cover only some API
methods. Lastly, they can
be revoked at any time. This range of possibilities makes API keys well
suited for separating the API access rights across multiple applications
or use cases.
Finally, the loss of an API key is easily manageable.
You can manage your API keys from
[GUI](https://portal.phonovation.com/settings/accounts/api-keys), or
programmatically
with [dedicated API](#platform-&-connectivity/settings).
API key Authorization header example:
```shell
Authorization: App
003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
```
name: Authorization
in: header
x-default: 'App '
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.