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.
openapi: 3.2.0
info:
title: Cosvoice Com Messages API
version: 1.0.0
contact:
name: CosVoice
url: https://cosvoice.com/contact
termsOfService: https://cosvoice.com/terms
description: 'Operations tagged Messages across 2 of this provider''s published API definitions: cosvoice-com-openapi.json, cosvoice-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://cosvoice.com/api/v1
security:
- bearerAuth: []
tags:
- name: Messages
paths:
/messages:
get:
operationId: listMessages
summary: Texts to and from the line
security:
- bearerAuth: []
responses:
'200':
description: Messages.
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
tags:
- Messages
post:
operationId: sendText
summary: Send a text from the line's number
description: US carriers only deliver business texts from registered numbers; CosVoice's registration is in progress, so a text may be filtered. Use a call or email when it must arrive.
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- to
- body
properties:
to:
type: string
description: E.164.
body:
type: string
description: The message.
responses:
'200':
description: Handed to the carrier.
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
tags:
- Messages
servers:
- url: https://cosvoice.com/api/v1
components:
schemas:
Error:
type: object
properties:
error:
type: string
description: What went wrong, in plain words you can show the owner.
required:
- error
responses:
NotFound:
description: No such call, email, or contact on this line.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
BadRequest:
description: Something in the request is missing or malformed; the message says which field.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: The key is missing, wrong, or revoked. Ask the owner for a new one; do not retry.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
RateLimited:
description: Over 240 requests a minute. Wait a little and try again.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: A line's API key (cv_live_…), from Settings → Connect your agent.
x-refined-from:
- cosvoice-com-openapi.json
- cosvoice-com-openapi.yml