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.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/vcita:vcita-communication-messages-sms-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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Communication Messages (SMS) API
description: Unified OpenAPI specification for communication domain
version: '3.0'
x-generated:
sourceFiles:
- contact_channels.json
- communication.json
- staff_notification.json
- business_phone_numbers.json
- legacy_v1_communication.json
- activity_message.json
- communication.json
- conversations.json
- notification_template.json
- legacy_v2_communication.json
- messages.json
pathNormalizations:
- file: communication.json
basePath: /business/communication
transformations:
- original: /channels
normalized: /business/communication/channels
basePath: /business/communication
- original: /channels/{uid}
normalized: /business/communication/channels/{uid}
basePath: /business/communication
- original: /messages
normalized: /business/communication/messages
basePath: /business/communication
- original: /messages/{messageUid}
normalized: /business/communication/messages/{messageUid}
basePath: /business/communication
- original: /sessions
normalized: /business/communication/sessions
basePath: /business/communication
- original: /sessions/typing
normalized: /business/communication/sessions/typing
basePath: /business/communication
- original: /sessions/{uid}
normalized: /business/communication/sessions/{uid}
basePath: /business/communication
- file: legacy_v1_communication.json
basePath: /platform/v1
transformations:
- original: /conversations
normalized: /platform/v1/conversations
basePath: /platform/v1
- original: /clients/{client_id}/conversations
normalized: /platform/v1/clients/{client_id}/conversations
basePath: /platform/v1
- original: /messages
normalized: /platform/v1/messages
basePath: /platform/v1
- original: /numbers/dedicated_numbers/assign
normalized: /platform/v1/numbers/dedicated_numbers/assign
basePath: /platform/v1
- original: /numbers/dedicated_numbers/set_two_way_texting_status
normalized: /platform/v1/numbers/dedicated_numbers/set_two_way_texting_status
basePath: /platform/v1
- original: /numbers/twilio
normalized: /platform/v1/numbers/twilio
basePath: /platform/v1
- original: /numbers/twilio/{sub_account_id}
normalized: /platform/v1/numbers/twilio/{sub_account_id}
basePath: /platform/v1
- file: conversations.json
basePath: /v2
transformations:
- original: /conversations/{id}
normalized: /v2/conversations/{id}
basePath: /v2
- file: legacy_v2_communication.json
basePath: /v2
transformations:
- original: /conversations/{conversation_id}/messages
normalized: /v2/conversations/{conversation_id}/messages
basePath: /v2
- file: messages.json
basePath: /business/messaging
transformations:
- original: /v1/channels
normalized: /business/messaging/v1/channels
basePath: /business/messaging
- original: /v1/channels/typing
normalized: /business/messaging/v1/channels/typing
basePath: /business/messaging
pathConflicts: []
componentConflicts:
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_communication
files:
- merged
- communication.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_staff_notification
files:
- merged
- staff_notification.json
- type: schema
name: Response
resolution: Renamed to Response_business_phone_numbers
files:
- merged
- business_phone_numbers.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_business_phone_numbers
files:
- merged
- business_phone_numbers.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_activity_message
files:
- merged
- activity_message.json
- type: schema
name: Response
resolution: Renamed to Response_communication
files:
- merged
- communication.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_conversations
files:
- merged
- conversations.json
totalPaths: 36
totalComponents: 50
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- description: 'Nexmo-based communication gateway endpoints for SMS/messaging channels. These endpoints follow an async webhook-based lifecycle: channels and sessions start as ''pending'' and are activated asynchronously via webhook callbacks from the communication-gw to the calling application. A webhook listener is required to receive activation events.'
name: Communication Messages (SMS)
paths:
/business/communication/channels:
post:
description: '## Overview
Create a new business'' communication channel. Available for **Staff, App, and Directory tokens**.
**Note:** Channels start with a `pending` status upon creation. They are activated asynchronously via a webhook callback from the communication-gw to the calling application. The channel will transition to `active` status only after the webhook activation event is received and processed.'
operationId: ChannelsController_create
parameters: []
responses:
'201':
description: Channel has been successfully registered.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/ChannelResponseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Create a Business Communication Channel
tags:
- Communication Messages (SMS)
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChannelDto'
security:
- Bearer: []
/business/communication/channels/{uid}:
delete:
description: '## Overview
Deletes an existing channel. Available for **Staff, App, and Directory tokens**.
**Note:** Channels follow an async webhook-based lifecycle. Channels start as `pending` and are activated asynchronously via webhook callback from the communication-gw.'
operationId: ChannelsController_deleteChannel
parameters:
- in: path
name: uid
required: true
schema:
type: string
responses:
'200':
description: Channel deleted successfully.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/BaseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Delete a Business Communication Channel
tags:
- Communication Messages (SMS)
security:
- Bearer: []
put:
description: '## Overview
Update an existing communication channel. Available for **Staff, App, and Directory tokens**.
**Note:** Channels follow an async webhook-based lifecycle. Channels start as `pending` and are activated asynchronously via webhook callback from the communication-gw.'
operationId: ChannelsController_updateChannel
parameters:
- in: path
name: uid
required: true
schema:
type: string
responses:
'200':
description: Channel status updated successfully.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/BaseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Update a Business Communication Channel
tags:
- Communication Messages (SMS)
security:
- Bearer: []
/business/communication/messages:
post:
description: '## Overview
Send a message to a business. Available for **Staff, App, and Directory tokens**.
**Note:** Sending messages requires a channel with `active` status. Channels are activated asynchronously via webhook callback from the communication-gw, not immediately upon creation. Ensure the channel has been activated before attempting to send messages.'
operationId: MessagesController_createMessage
parameters: []
responses:
'201':
description: Message sent successfully.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/MessageResponseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: The AI Receptionist cannot take an inbound message on a channel it intercepts. For example, the business turned the AI Receptionist off, the AI chats for this month are used up, or the AI Receptionist app is not installed. The message is not saved and does not go to the inbox. The channel app must handle the message with its own flow, for example a bot that asks for the sender's details. After that, the app can set `ai_status` to `ai_released` on the session (see Update a Business Communication Session). The error code is `err_receptionist_unavailable` (e.g., "err_receptionist_unavailable").
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- code: err_receptionist_unavailable
message: AI receptionist unavailable for channel [ch_8f2a1c] — channel app should handle this message.
summary: Create a Business Communication Message
tags:
- Communication Messages (SMS)
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMessageDto'
security:
- Bearer: []
/business/communication/messages/{messageUid}:
put:
description: '## Overview
Update message status. Available for **Staff, App, and Directory tokens**.
**Note:** Messages are part of the async webhook-based communication lifecycle. Sending messages requires a channel with `active` status, which is set asynchronously via webhook callback from the communication-gw.'
operationId: MessagesController_updateStatus
parameters:
- in: path
name: messageUid
required: true
schema:
type: string
responses:
'200':
description: Message status updated successfully.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/BaseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Update Business Communication Message
tags:
- Communication Messages (SMS)
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMessageDto'
security:
- Bearer: []
/business/communication/sessions:
post:
description: '## Overview
Create a new inactive session over a channel between the app''s contact and vCita''s contact. Available for **Staff, App, and Directory tokens**.
**Note:** Sessions require an active channel (activated via webhook callback from the communication-gw). Sessions themselves start as `pending` and are also activated asynchronously via webhook callback.'
operationId: SessionsController_createSession
parameters: []
responses:
'201':
description: Session created successfully.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/SessionResponseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Create a Business Communication Session
tags:
- Communication Messages (SMS)
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSessionDto'
security:
- Bearer: []
get:
description: '## Overview
Retrieve sessions. Deep object style. Example: filter[channel_uid]=channeluuid. Available for **Staff, App, and Directory tokens**.
**Note:** Sessions require an active channel (activated via webhook callback from the communication-gw). Sessions themselves are also activated asynchronously via webhook.'
operationId: SessionsController_getSession
parameters:
- description: Channel identifier
in: query
name: channel_uid
required: true
x-example: c697a91c-ce0c-469e-918b-fdc2ff6f8a04
schema:
type: string
- description: Business identifier
in: query
name: business_uid
required: true
x-example: 5wbdaiig4avpwl40
schema:
type: string
- description: vCita contanct identifier
in: query
name: contact_uid
required: false
x-example: 2nbreiig9avawl81
schema:
type: string
responses:
'200':
description: Sessions of specific channel (can be filtered by contact_uid)
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/MultiSessionResponseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Retrieve a Business Communication Session
tags:
- Communication Messages (SMS)
security:
- Bearer: []
/business/communication/sessions/typing:
post:
description: '## Overview
Populate typing indicator status. Available for **Staff, App, and Directory tokens**.
**Note:** Requires an active session, which in turn requires an active channel. Both channels and sessions are activated asynchronously via webhook callbacks from the communication-gw.'
operationId: SessionsTypingController_typingStatus
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/BaseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Create a Business Communication Session Typing indicator
tags:
- Communication Messages (SMS)
security:
- Bearer: []
/business/communication/sessions/{uid}:
delete:
description: '## Overview
Deletes an existing session. Available for **Staff, App, and Directory tokens**.
**Note:** Sessions follow an async webhook-based lifecycle. Sessions require an active channel (activated via webhook) and are themselves activated asynchronously via webhook callback.'
operationId: SessionsController_logicDelete
parameters:
- in: path
name: uid
required: true
schema:
type: string
responses:
'200':
description: Session deleted successfully.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/BaseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Delete a Business Communication Session
tags:
- Communication Messages (SMS)
security:
- Bearer: []
put:
description: '## Overview
Activating/deactivating an existing session. Available for **Staff, App, and Directory tokens**.
**Note:** Sessions follow an async webhook-based lifecycle. Sessions require an active channel (activated via webhook) and are themselves activated asynchronously via webhook callback from the communication-gw.'
operationId: SessionsController_updateStatus
parameters:
- in: path
name: uid
required: true
schema:
type: string
responses:
'200':
description: Session activation request received successfully. Once change has occurred, the App will receive an API request confirming the status change.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
$ref: '#/components/schemas/SessionResponseDto'
'401':
description: Unauthorized to perform action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Update a Business Communication Session
tags:
- Communication Messages (SMS)
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSessionDto'
security:
- Bearer: []
components:
schemas:
MessageResponseDto:
properties:
message:
$ref: '#/components/schemas/MessageResponseEntity'
required:
- message
type: object
UpdateMessageDto:
properties:
channel_uid:
description: Channel uid of the message.
type: string
status:
description: Message's new status. Enum MessageStatus
enum:
- pending
- channel_pending
- sent
- received
- read
- error
- unavailable
type: string
required:
- status
- channel_uid
type: object
SessionResponseDto:
properties:
session:
$ref: '#/components/schemas/SessionResponse'
required:
- session
type: object
BaseDto:
properties: {}
type: object
ChannelResponseDto:
properties:
channel:
$ref: '#/components/schemas/ChannelResponseEntity'
required:
- channel
type: object
MessageResponseEntity:
properties:
status:
description: Message status. Enum MessageStatus.
enum:
- pending
- channel_pending
- sent
- received
- read
- error
- unavailable
type: string
uid:
description: Message uid
type: string
required:
- uid
- status
type: object
ChannelResponseEntity:
properties:
display_name:
description: Channel display name.
type: string
status:
description: Channel status. Enum ChannelStatus.
enum:
- pending
- active
- inactive
- deleted
- blocked
- error
type: string
uid:
description: Channel uid. 36 chars uuid, this is the identifier for the created channel.
type: string
required:
- uid
- status
- display_name
type: object
UpdateSessionDto:
properties:
ai_status:
description: AI routing status. The AI receptionist app may set any value. A source channel app may set only `ai_released`, and only on a session with `ai_status` `ai_intercepted` and a contact (`contact_uid` in this request or already on the session). The source app does this after its own flow handled a message that the AI receptionist could not take (503 `err_receptionist_unavailable` on Create a Business Communication Message). Other values from a source app are refused (e.g., "ai_intercepted", "ai_released").
enum:
- none
- ai_intercepted
- ai_released
type: string
status:
description: Session lifecycle status. Source channel apps use this field to activate, deactivate, or delete the session.
enum:
- inactive
- active
- deleted
type: string
type: object
ErrorResponse:
type: object
properties:
success:
type: boolean
errors:
type: array
items:
type: object
properties:
field:
type: string
description: The field that caused the error (for validation errors)
code:
type: string
message:
type: string
required:
- code
- message
required:
- success
- errors
example:
success: false
errors:
- field: contact_uid
code: invalid
message: contact_uid is required.
CreateChannelDto:
properties:
business_uid:
description: Business uid. 16 business identifier for which the channel will be created for.
type: string
display_name:
description: channel display name..
type: string
type:
description: Type of channel. Enum ChannelType.
enum:
- transactional
- promotional
type: string
required:
- business_uid
- type
type: object
SessionResponse:
properties:
ai_status:
description: 'AI routing status for the session. `none` means the session is not currently owned by the AI receptionist; `ai_intercepted` means inbound messages are routed to the AI receptionist; `ai_released` means the session went back to the CRM: the AI receptionist handed it back, or the source channel app released it after the AI receptionist could not take a message (e.g., "none", "ai_intercepted", "ai_released").'
enum:
- none
- ai_intercepted
- ai_released
type: string
status:
description: 'Session lifecycle status: `pending` (created, awaiting activation), `inactive` (not currently routing), `active` (live), `deleted` (removed by a source channel app), or `failed` (could not be established).'
enum:
- pending
- inactive
- active
- deleted
- failed
type: string
uid:
description: Session uid
type: string
required:
- uid
- status
- ai_status
type: object
Response:
properties:
data:
type: object
success:
type: boolean
required:
- success
- data
type: object
MultiSessionResponseDto:
properties:
sessions:
items:
$ref: '#/components/schemas/SessionResponse'
type: array
required:
- sessions
type: object
CreateSessionDto:
properties:
business_uid:
description: 16 chars business identifier.
type: string
channel_uid:
description: 36 chars channel identifier.
type: string
contact_uid:
description: vCita contact identifier.
type: string
external_uid:
description: App's contact identifier.
type: string
required:
- business_uid
- channel_uid
- contact_uid
- external_uid
type: object
CreateMessageDto:
properties:
attachments:
description: Message attachments
items:
type: object
type: array
channel_uid:
description: Channel uid. 36 chars uuid.
type: string
contact_uid:
description: Contact Uid
type: string
contact_data:
additionalProperties:
type: string
description: 'Optional channel-provided contact metadata for AI Chat Receptionist context, such as contact_name, email, phone, or other scalar contact details. This object is metadata only: it does not participate in routing or session lookup, and contact_uid/external_uid remain the routing identifiers. When provided on an intercepted inbound message without contact_uid, communication-gw forwards it to the AI receptionist as unverified client context and does not include it in the normal CRM fallback message payload.'
example:
contact_name: Itzik Levy
email: itzik@example.com
phone: '+15551234567'
company: Acme
type: object
created_at:
description: 'Message creation date time [optional | Format: YYYY-MM-DD HH:MM:SS].'
type: string
direction:
description: Message Direction.
enum:
- client_to_business
- business_to_client
type: string
external_uid:
description: Paired contact code.
type: string
message:
description: Message content.
type: string
message_uid:
description: Message uid. Max 255 chars identifier. vCita will send message status updates based on this identifier.Must be unique per channel.
type: string
required:
- external_uid
- message
- message_uid
- channel_uid
type: object
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
Conversations:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid staff bearer token in the Authorization header. Example: ''Authorization: Bearer {staff_token}''.'
x-provenance:
method: searched
source: https://developers.intandem.tech:443/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.intandem.tech/reference/availablephonenumberscontroller_findall.md
- https://developers.intandem.tech/reference/businessphonenumberscontroller_create.md
- https://developers.intandem.tech/reference/businessphonenumberscontroller_findall.md
- https://developers.intandem.tech/reference/businessphonenumberscontroller_findone.md
- https://developers.intandem.tech/reference/businessphonenumberscontroller_update.md
- https://developers.intandem.tech/reference/channelscontroller_create.md
- https://developers.intandem.tech/reference/channelscontroller_deletechannel.md
- https://developers.intandem.tech/reference/channelscontroller_updatechannel.md
- https://developers.intandem.tech/reference/contactchannelscontroller_index.md
- https://developers.intandem.tech/reference/delete_platform-v1-numbers-twilio-sub-account-id.md
- https://developers.intandem.tech/reference/delete_v3-communication-notification-templates-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-conversations-1.md
- https://developers.intandem.tech/reference/get_platform-v1-conversations.md
- https://developers.intandem.tech/reference/get_v2-conversations-conversation-id-messages.md
- https://developers.intandem.tech/reference/get_v3-communication-notification-templates-uid.md
- https://developers.intandem.tech/reference/get_v3-communication-notification-templates.md
- https://developers.intandem.tech/reference/get_v3-communication-staff-notifications-uid.md
- https://developers.intandem.tech/reference/getstaffnotificationstats.md
- https://developers.intandem.tech/reference/listactivitymessages.md
- https://developers.intandem.tech/reference/liststaffnotifications.md
- https://developers.intandem.tech/reference/messagescontroller_createmessage.md
- https://developers.intandem.tech/reference/messagescontroller_updatestatus.md
- https://developers.intandem.tech/reference/post_business-messaging-v1-channels-typing.md
- https://developers.intandem.tech/reference/post_business-messaging-v1-channels.md
- https://developers.intandem.tech/reference/post_platform-v1-messages.md
- https://developers.intandem.tech/reference/post_platform-v1-numbers-dedicated-numbers-assign.md
- https://developers.intandem.tech/reference/post_platform-v1-numbers-twilio.md
- https://developers.intandem.tech/reference/post_v3-communication-notification-templates.md
- https://developers.intandem.tech/reference/post_v3-communication-staff-notifications.md
- https://developers.intandem.tech/reference/put_platform-v1-numbers-dedicated-numbers-set-two-way-texting-status.md
- https://developers.intandem.tech/reference/put_v2-conversations-id.md
- https://developers.intandem.tech/reference/put_v3-communication-notification-templates-uid.md
- https://developers.intandem.tech/reference/quotascontroller_getquota.md
- https://developers.intandem.tech/reference/recordingscontroller_deletevoicecallrecording.md
- https://developers.intandem.tech/reference/recordingscontroller_updatevoicecallrecording.md
- https://developers.intandem.tech/reference/reportscontroller_getvoicecallstats.md
- https://developers.intandem.tech/reference/sendactivitymessage.md
- https://developers.intandem.tech/reference/sessionscontroller_createsession.md
- https://developers.intandem.tech/reference/sessionscontroller_getsession.md
- https://developers.intandem.tech/reference/sessionscontroller_logicdelete.md
- https://developers.intandem.tech/reference/sessionscontroller_updatestatus.md
- https://developers.intandem.tech/reference/sessionstypingcontroller_typingstatus.md
- https://developers.intandem.tech/reference/settingscontroller_create.md
- https://developers.intandem.tech/reference/settingscontroller_delete.md
- https://developers.intandem.tech/reference/settingscontroller_get.md
- https://developers.intandem.tech/reference/settingscontroller_update.md
- https://developers.intandem.tech/reference/transcriptcontroller_gettranscript.md
- https://developers.intandem.tech/reference/voicecallscontroller_create.md
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-communication-messages-sms-api-openapi.yml