Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/talkdesk:talkdesk-messages-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Talkdesk Messages API
version: 1.0.0
contact:
name: Talkdesk
url: https://talkdesk.com
description: 'Operations tagged Messages across 2 of this provider''s published API definitions: talkdesk-public-bundle.json, talkdesk-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.talkdeskapp.com
description: United States (td-us-1)
- url: https://api.talkdeskapp.eu
description: Europe (td-eu-1)
- url: https://api.talkdeskappca.com
description: Canada (td-ca-1)
- url: https://api.talkdeskapp.co.uk
description: United Kingdom (td-uk-1)
tags:
- name: Messages
description: ''
paths:
/messages:
post:
operationId: messages-post
summary: SMS Message Delivery
description: Sends an outbound SMS message to a contact phone number using a Talkdesk phone number. The request is processed asynchronously and returns a 202 status on acceptance. Use this endpoint to programmatically deliver SMS notifications or messages to contacts. Phone numbers must be in E.164 format when provided.
security:
- GA:
- messages:write
tags:
- Messages
parameters: []
responses:
'202':
description: The message was accepted to be delivered
content:
application/json:
schema:
example:
id: 8b62e0c6001548d7b59f8240d79cb0d7
contact_phone_number: '+123456789000'
talkdesk_phone_number: '+351999999999'
body: Lorem Ipsum
_links:
self:
href: http://api-docs.talkdesk.org/messages/8b62e0c6001548d7b59f8240d79cb0d7
type: object
additionalProperties: false
required:
- id
allOf:
- type: object
required:
- body
properties:
talkdesk_phone_number:
type: string
description: The E.164 compliant phone number sending the message
contact_phone_number:
type: string
description: The E.164 compliant phone number receiving the message
body:
type: string
description: The content of the message to be delivered
- properties:
id:
type: string
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
default: http://api-docs.talkdesk.org/messages/:id
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
description:
type: string
fields:
type: array
items:
type: object
required:
- name
- description
properties:
name:
type: string
description:
type: string
example:
code: '0440004'
message: Invalid request to send a message
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
description:
type: string
fields:
type: array
items:
type: object
required:
- name
- description
properties:
name:
type: string
description:
type: string
example:
code: '0440005'
message: The request is not authorized
'403':
description: Forbidden
content:
application/json:
schema:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
description:
type: string
fields:
type: array
items:
type: object
required:
- name
- description
properties:
name:
type: string
description:
type: string
example:
code: '0440006'
message: The request is forbidden
'429':
content:
application/json:
schema:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
description:
type: string
fields:
type: array
items:
type: object
required:
- name
- description
properties:
name:
type: string
description:
type: string
description: Rate Limit Exceeded.
'500':
content:
application/json:
schema:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
description:
type: string
fields:
type: array
items:
type: object
required:
- name
- description
properties:
name:
type: string
description:
type: string
description: Internal Server Error.
requestBody:
description: The body of the request
content:
application/json:
schema:
type: object
required:
- body
properties:
talkdesk_phone_number:
type: string
description: The E.164 compliant phone number sending the message
contact_phone_number:
type: string
description: The E.164 compliant phone number receiving the message
body:
type: string
description: The content of the message to be delivered
components:
securitySchemes:
GA:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://{account_name}.talkdeskid.com/oauth/authorize
tokenUrl: https://{account_name}.talkdeskid.com/oauth/token
scopes:
account:read: Show account details
apps:read: Get details about app installations for an account
apps:write: Update an app installation state programatically
attributes:read: List attributes or attribute categories for an account and get details for a specific attribute
attributes:write: Create, update and remove attributes or attributes categories for an account
bulk-imports:read: Get list of imports and export errors into CSV file
bulk-imports:write: Create and update import data
messages:write: Ability to send messages from the API
callback:write: Request a new direct callback
contacts-integrations:read: Get details for contacts' integrations
contacts:read: Get details for contact(s)
contacts:write: Create, update or delete contacts
contact-gdpr:write: GDPR Contacts
continuity-settings:read: Read business continuity settings
continuity-settings:write: Change business continuity settings
continuity-settings-activation:read: Read information on activation of the continuity settings
continuity-settings-activation:write: Edit information on activation of the continuity settings
data-reports:read: Download previously generated data reports
data-reports:write: Create new data reports
data-tables:read: Fetch and list data tables
data-tables:write: Create and update data tables
data-tables-exports:read: List and download data table exports
data-tables-exports:write: Create and cancel data table exports
events:read: Get details from received events
express-provisioning:read: Express-provisioning validate if account exists
express-provisioning:write: Provisioning of an account
express-accounts-usage:read: Read usage information for an account
express-accounts:read: Read account information
express-accounts-contracts:read: Get contract info for express accounts
express-accounts-contracts-actions:write: Create contract actions for express accounts
express-accounts-contracts-actions:read: Read contract actions of express accounts
express-products:read: Read product information
express-accounts-subscriptions:read: Read subscription information for an account
express-accounts-invoices:read: Read invoice information for an account
erc-ecommerce-shopify-webhooks-handler-credentials:write: Create or update Shopify webhook handler credentials
erc-ecommerce-shopify-webhooks-handler-credentials:read: Read Shopify webhook handler credentials
flows-interactions:start: Starts an interaction associated with a flow
flows-platform:submit: Trigger an automation flow associated with an account
fsi-accounts:read: List of accounts associated with a contact
fsi-contacts:write: Update contact information
fsi-contacts:read: List and get contact details
fsi-cards:read: List of cards from a account
fsi-cards:write: Update the status for a card
fsi-payments:read: List of payments from a specific account
fsi-transactions:read: List of transactions for a specific account
fsi-payoff:read: Get the payoff for an FSI account
fsi-transfers:write: Create an FSI Transfer
fsi-stop-payment:write: Cancel a payment before it’s been processed
fsi-travel-notification:write: Create a new endpoint for Travel Notifications
fsi-checks:read: Search for a check
fsi-set-ach-transfer:write: FSI Set ACH Transfer
fsi-unlock-account:write: Unlock account for a banking customer
fsi-decrypt:read: The decryption based on AES algorithm
fsi-write-back:write: FSI Write Data Back
fsi-spend-limit:read: Daily limit for reading debit cards
fsi-spend-limit:write: Modify the daily limit of debit cards
guardian-call-quality:read: Read Guardian call quality data.
guardian-sessions:read: Read Sessions Guardian data.
guardian-users:read: Read Users Guardian data.
guardian-cases:read: Read Cases Guardian data.
identity-activity:read: Identity activity read access
identity-email-validation:read: Identity Email Validation read access
identity-ip-validation:read: Identity IP Validation read access
identity-phone-validation:read: Identity Phone Validation read access
openid: User info endpoint
recordings:read: Get recording files
recordings:delete: Delete recording files
refresh_token: Token refresh flow
reports:read: List previously generated reports and download them
reports:write: Create new reports or delete existing ones
queues:read: List CCAAS queues
queues:write: Create/update CCAAS queues details
queues-users:read: List users assigned to a CCAAS queue
users:read: List users for an account and get details for a specific user
users:write: Create, Update and Delete users
interactions:control-recordings: Control the recording status of an interaction
fsi-workspace-contact-synchronization:write: Synchronize Talkdesk contact with fsi member information
voicebiometrics-enroll:write: Update and delete Voice Biometrics enroll data
voicebiometrics-consent:read: VoiceBiometrics consent read access
voicebiometrics-consent:write: VoiceBiometrics consent write access
live-queries:read: Read and list queries from Live API
live-subscriptions:read: Read subscriptions from Live API
live-subscriptions:write: Create a new subscription for Live API
wfm-aion-public:write: Create, Update and Delete WFM Aion related data by an external client.
wfm-request-management-public:write: Create, Update and Delete WFM Request Management related data by an external client.
wfm-request-management-public:read: Read WFM Request Management related data by an external client.
account-wallets:read: Get information about account wallets
bucket-configurations:read: Get all bucket configurations
cases-public:write: Create,update and delete case data
cases-public:read: Read case
case-notes-public:read: Read case note data
case-notes-public:write: Create, edit, and delete case note data
case-fields-public:read: Read case field
do-not-call-lists:manage: Update a DNCL by adding or deleting a entry on a do not call list
do-not-call-lists:read: Read entries in a do not call list
record-lists:manage: Ability to view, add and update records of a Record List
record-lists:write: Create and update record lists for an account
role-permissions:skip: Skip role permissions validation
campaigns:write: Create, update and delete campaigns
campaigns:read: List and view available campaigns
schedule-callbacks:read: List schedule callbacks
schedule-callbacks:write: schedule a callbacks or reschedule a callbacks
po-record-list-automations:write: Custom record list automations for proactive outbound clients
prompts:read: Read prompts
prompts:write: Create a prompt
prompts:delete: Delete a prompt
prompts:download: Get prompt download link
webhooks-trigger:write: Create, update and delete a webhook trigger
cfm-public:write: Collect feedback data
digital-connect:read: List and Get digital-connect Resources
digital-connect:write: Create, Update and Delete digital-connect Resources
entitymapper-contact-interactions:write: Update interaction's contact mappings
locations-directory:read: Read locations information
locations-directory:write: Write/update locations information and custom fields
locations-directory:support: Create/Update/Delete locations-directory support features
staffs-directory:read: Read staffs information
staffs-directory:write: Write/update staffs information
automated-notifications-management:read: Read Automated Notifications related account information
automated-notifications-management:write: Write Automated Notifications related account information
automated-notifications:read: Read Automated Notifications event information
automated-notifications:write: Write Automated Notifications event information
automated-notifications-bridge:write: Write permissions for automated-notifications-bridge webhooks
automated-notifications-subscriptions:read: Read Automated Notifications subscriptions related to a topic/channel
automated-notifications-subscriptions:write: Write (subscribe/unsubscribe) Automated Notifications subscriptions related to a topic/channel
entitymapper-map:write: Write mappings with external entities
entitymapper-contacts:read: Search Talkdesk contact
entitymapper-contacts:write: Write Talkdesk contact
appointment-scheduling-va:read: Read appointment scheduling va entries
hls-coverage:read: Read healthcare & life sciences coverage information
hls-balance:read: Read healthcare & life sciences balance information
hls-patient:read: Read healthcare & life sciences patient information
hls-providers:call-answered: Write healthcare & life sciences call answered information
hls-appointment:read: Read healthcare & life sciences patient appointments
hls-medication-order:read: Read healthcare & life sciences patient medication orders
hls-appointment:write: Write healthcare & life sciences patient appointments
hls-contact:write: Write healthcare & life sciences data into talkdesk contact
hls-provider:read: Read healthcare & life sciences provider appointments
hls-phone-action:write: Write healthcare & life sciences phone action
hls-click-to-call:write: Write healthcare & life sciences click-to-call action
hls-epic-outgoing-sms:write: Trigger outgoing SMS from Epic
hls-epic-agent-status-sync:write: Trigger agent status sync from Epic
hls-inbasket-message:write: Send in-basket message to Epic
hls-popup-intent:write: Save intent of a patient
hls-prescription:read: Read healthcare & life sciences prescription information
hls-prescription:write: Write healthcare & life sciences prescription information
hls-encounter:read: Read healthcare & life sciences patient encounters
hls-service-request:read: Read healthcare & life sciences patient service requests
hls-procedure:read: Read healthcare & life sciences patient procedures
hls-payers-connections:read: Read healthcare & life sciences payers information
hls-payers-connections:write: Write healthcare & life sciences payers information
hls-symptom-checker:write: Symptom checker for patient
hls-patient:write: Write healthcare & life sciences patient information
hls-epic:call-answered: Write healthcare & life sciences call answered information
hls-sycurio:integrate: Integrate with Sycurio platform
hls-patient-case:write: Write healthcare & life sciences patient case information
hls-outstanding-order:read: Read healthcare & life sciences outstanding orders
hls-medication-order:write: Write healthcare & life sciences medication order(request)
hls-medication-statement:write: Write healthcare & life sciences medication statement
hls-medication-statement:read: Read healthcare & life sciences medication statement
hls-hl7-events:write: Write healthcare providers HL7 events
erc-ecommerce-connections-orders:write: Update e-commerce connections orders info
erc-ecommerce-connections-customers:read: Read e-commerce connections customers info
erc-ecommerce-connections-customers:write: Write e-commerce connections customers info
erc-ecommerce-connections-orders:read: Read e-commerce connections orders info
erc-ecommerce-connections-products:read: Read e-commerce connections products info
erc-ecommerce-customers:read: Read e-commerce customers info
erc-ecommerce-customers:write: Write e-commerce customers info
erc-ecommerce-return-reasons:read: Read e-commerce return reasons
erc-ecommerce-return:read: Read e-commerce return info
erc-ecommerce-return:write: Write e-commerce return info
erc-ecommerce-cart:write: Sync e-commerce cart items
erc-ecommerce-products:read: Search e-commerce catalog products
erc-ecommerce-orders:read: Show e-commerce integrations orders info
erc-ecommerce-orders:write: Update e-commerce integrations orders info
erc-ecommerce-recall:write: Write e-commerce recall contacts
industries-settings-public:write: Write industries settings
industries-contexts:write: Create, update, and delete context values
fsi-insurance-connections-automated-notifications:write: Write Automated Notifications event information
fsi-insurance-connections-contacts:write: Sync Talkdesk contacts
fsi-insurance-connections-claims:read: Read claims by id from FSI Insurance
fsi-insurance-integrations-policies:read: Read policies from FSI Insurance
fsi-insurance-integrations-accounts:read: Read accounts from FSI Insurance
fsi-insurance-integrations-claims:write: Write claims from FSI Insurance
fsi-insurance-integrations-billing:read: Read billing info from FSI Insurance
fsi-insurance-integrations-claims:read: Read claims from FSI Insurance
fsi-insurance-integrations-contacts:write: Update contact details from FSI Insurance
fsi-insurance-integrations-send-docs:read: Send document deliveries from FSI Insurance
fsi-insurance-integrations-data-back:write: Write contact event data back to FSI Insurance
automated-notifications-interactions:read: Read Automated Notifications related with interactions
industries-scheduler-teams:read: Read teams from industries-scheduler
industries-scheduler-availabilities:read: Get users availabilities by email
industries-scheduler-appointment:write: Create cancel event on specialist's calendar
industries-scheduler-appointment:read: Read appointments from industries-scheduler
industries-messaging-service:write: Write messages in industries-messaging-service
interaction-custom-fields:write: Allows to populate interaction custom fields
user-session-public:end: Terminate a user session
industries-settings-public:read: Read industries settings
industries-contexts:read: Read context values
dialer-integrations-records:read: Read dialer integrations campaign records
scim: Access SCIM-related routes
hls-epic-my-chart-reset-password:write: Trigger Epic MyChart password reset (Deprecated - use hls-patient-password-reset:write)
hls-patient-password-reset:write: Trigger patient password reset for healthcare portal
locations-directory-bulk-operation:write: Write locations directory data
locations-directory-batch-operation:write: Apply a batch of locations directory create/update/delete operations
hls-patient-location:read: Read loction patient data
hls-patient-practice:read: Read healthcare & life sciences patient practices
hls-guarantor:read: Read guarantor identifiers from providers
hls-guarantor-billing:read: Read guarantor billing summary from providers
hls-guarantor-password-reset:write: Trigger guarantor password reset for healthcare portal
hls-patient-billing:read: Read patient billing details from providers
hls-interaction-overrides:write: Write healthcare & life sciences interaction-specific configuration overrides
industries-workflows:read: Read industries workflow schedules and workflows
industries-workflows:write: Create, update, start, and delete industries workflow schedules and workflows
industries:proxies-conversations-analysis:invoke: Invoke calls through the Talkdesk Conversations API proxy
digital-messaging-adapter:write: Write or update Digital Messaging Adapter data
Deprecated:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://{account_name}.talkdeskid.com/oauth/authorize
tokenUrl: https://{account_name}.talkdeskid.com/oauth/token
scopes:
attributes:read: List attributes or attribute categories for an account and get details for a specific attribute
EarlyAccess:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://{account_name}.talkdeskid.com/oauth/authorize
tokenUrl: https://{account_name}.talkdeskid.com/oauth/token
scopes:
messages:read: Ability to read messages from the API
mcp-server:read: Access the MCP server and call its read-only operation tools
mcp-server:write: Call any MCP operation tool, including those that change data
presence-account:read: Read Account presence
presence-user:read: Read User presence
presence-occupancy:write: Write User occupancy
presence-status:write: Write User status
interactions-announcement:write: Control the announcements in an interaction
contacts-custom-fields:read: Search the custom fields for a given contact
contacts-activities:read: List activities for a contact
wfm-public:read: Get WFM related public data.
wfm-public:write: Create, Update and Delete WFM related public data.
industries-activity:write: Create and update industries activities and events
functions:execute: Execute functions in external provider
phone-details:read: Show phone details from a specific account
outbound-numbers:read: List phone numbers that the agent can use for outbounds
numbers:read: List numbers for an account
user-disposition-settings:write: Update disposition settings for the user
attachments:download: Generate a download link that gives temporary access to the attachment data
studio-callbacks:read: List studio callbacks
attachments:read: Get, and list attachments
attachments:request: Get request ids and urls for uploading
attachments:write: Create, and clone attachments
attachments:delete: Delete an attachment permanently
simulated-emails:write: Write to the eas send simulated email API
email-classifications:write: Classify inbound emails against a published taxonomy
fsi-insurance-connections-contacts:read: List and get insurance account holders
interactions-public:read: Read interactions for an account
ccaas-user-status:write: Update user status in ccaas
ccaas-user-status:read: Read user status in ccaas
km-external-sources:read: Read external sources in Talkdesk Knowledge Management
km-external-sources:write: Manage external sources in Talkdesk Knowledge Management
omnichannel:interaction-elimination: Eliminate an omnichannel interaction resource
industries-workato-hub: Allow calling industries workato using a Talkdesk Id OAuth Client
secure-messaging:read: Read secure messaging resources
secure-messaging:write: Create, update secure messaging resources
digital-connection-execution:write: Execute a digital connection action
digital-byob-webhook:write: Reply, Escalate and Resolve Digital interactions via BYOB
customer-data-store:read: Read the multi-channel message
email-connection-execution:write: Execute email connection
outbound-notifications:write: Send outbound notification messages
campaign-message:write: Send campaign message
licenses:read: Get the account licenses
seats:read: Get seats information of a license
seats:write: Add or remove seats from a license
voicemails:read: List voicemails for an account
voicemails:write: Change the voicemail status or assignment
ai-agent-conversations-export:read: Export AI Agent conversations
data-datasets:read: Lists, describes and queries reporting datasets through the dataset endpoints of Data Search API
digital-messenger:write: Create, update and delete digital-messenger resources
hls-pre-detection:invoke: Invoke HLS PRE Detection analysis of Potentially Recoverable Events
omni-interactions:read: Read omni interactions and their contexts
omni-interactions:write: Create and update omni interactions and their contexts
BYOAToken:
type: http
scheme: bearer
externalDocs:
description: External Documentation
url: https://api-docs.talkdeskapp.com/external_docs
x-refined-from:
- talkdesk-public-bundle.json
- talkdesk-openapi.yml