Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-1352578.3 KB
Messages

Create Message

Create Message

post/sms/messages

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

A unique identifier for an object.

fromstring required

The phone number that initiated the message.

tostring required

The phone number that received the message.

subjectstring
bodystring required

The message text.

type'sms' | 'mms'

Set to sms for SMS messages and mms for MMS messages.

number_of_unitsinteger

The number of units that make up the complete message. Messages can be split up due to the constraints of the message size.

number_of_media_filesinteger

The number of media files associated with the message.

direction'inbound' | 'outbound-api' | 'outbound-call' | 'outbound-reply' | 'unknown'

The direction of the message.

status'accepted' | 'scheduled' | 'canceled' | 'queued' | 'sending' | 'sent' | 'failed' | 'delivered' | 'undelivered' | 'receiving' | 'received' | 'read'

Status of the delivery of the message.

scheduled_atstring date-time

The scheduled date and time of the message.

sent_atstring date-time

The date and time that the message was sent

webhook_urlstring

Define a webhook to receive delivery notifications.

referencestring

A client reference.

messaging_service_idstring

The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "12345",
  "from": "+15017122661",
  "to": "+15017122662",
  "subject": "Picture",
  "body": "Hi! How are you doing?",
  "type": "sms",
  "number_of_units": 1,
  "number_of_media_files": 1,
  "direction": "outbound-api",
  "status": "sent",
  "scheduled_at": "2020-09-30T07:43:32.000Z",
  "sent_at": "2020-09-30T07:43:32.000Z",
  "webhook_url": "https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms",
  "reference": "CUST001",
  "price": {
    "per_unit": "0.01",
    "total_amount": "0.01",
    "currency": "USD"
  },
  "error": {
    "code": "X1",
    "message": "Something went wrong"
  },
  "messaging_service_id": "123456",
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Messages

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "twilio",
  "resource": "Messages",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}