SCG API documentation version 1.0.0

https://api.syniverse.com/scg-external-api/api/v1

About SCG

The purpose of this specification is to describe the Syniverse Communication Gateway (SCG) API set. The SCG is a REST API-based service providing advanced, omni channel messaging capability, voice calling, and Contact capabilities. The SCG service provides enhaned communication capabilities such as personalizing messages, tracking delivery reportes and conversion events, and providing a higher level of analytical information regarding comminication events. The SCG APIs are granular but suitable for reuse within solutions that perform higher level functionality.

Sender ID Class

This is an immutable resource that represents the list of sender classes that an be associated with a sender id. The sender class determines the type of messages (notifications, alerts, commercial ….) as well as message throughput and sending window restriction

Resource attributes:

id (string): Unique id of the sender class
name (string): Name of the sender class
description (string): human readable description of the sender class
designation (string): Primary channel designation- commercial, alerts, notifications …
applicable_countries (Array): (string): list of countries to which the sender class applies, coma delimited using iso country code. Allow a keyword of 'OTHER' for sender classes that are not country specific.
```
NOTE- for a country where a sender classes are defined, the 'OTHER' country sender classses are not available for customers to use
```
country_peak_throughput (number): Maximum outbound channel throughput for a given customer per destination country expressed in transactions per second
country_peak_total_throughput (number): Maximum outbound channel throughput for all customers using the short or Integer code per destination country expressed in transactions per second (this is the physical limit of the sender address)
country_daily_throughput (number): Maximum outbound channel throughput for a given customer per destination country expressed in transactions per day
delivery_window (string): Allowed delivery time for the messages. Applying the time validation, the time is to be considered in the time zone of the recipient. This is a JSON string with a list of allowed times by destination country. Countries are represented by an ISO country code. A special country code of 'DEFAULT' is to be used for the default country. For each country a delivery window can be specified. Each weekday can have different delivery window times. As weekday names, use of following days- MON, TUE, WED, THU, FRI, SAT, SUN as well as two additional keywords- HOL (representing local holiday in the country) and OTH (representing all other days of week)
created_date (date): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/messaging/sender_id_classes get

get
Returns the list of sender classes

Returns the list of sender classes

Request
Response

Query Parameters

id: (string)
Filter
name: (string)
Filter
designation: (string)
Filter
applicable_countries: (string)
Filter
country_peak_throughput: (number)
Filter
country_daily_throughput: (number)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Sender ID Class List",
  "type": "array",
  "items": {
    "title": "Sender ID Class",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "designation": {
        "type": "string"
      },
      "applicable_countries": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "country_peak_throughput": {
        "type": "number"
      },
      "country_peak_total_throughput": {
        "type": "number"
      },
      "country_daily_throughput": {
        "type": "number"
      },
      "delivery_window": {
        "type": "string"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/sender_id_classes/{Class_ID} get

The sender class resource associated with the provided ID

get
Returns the current version of the specified class

Returns the current version of the specified class

Request
Response

URI Parameters

Class_ID: required (string)
This is the unique identifier of the Class resource.

Query Parameters

id: (string)
Filter
name: (string)
Filter
designation: (string)
Filter
applicable_countries: (string)
Filter
country_peak_throughput: (number)
Filter
country_daily_throughput: (number)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Sender ID Class",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "designation": {
      "type": "string"
    },
    "applicable_countries": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "country_peak_throughput": {
      "type": "number"
    },
    "country_peak_total_throughput": {
      "type": "number"
    },
    "country_daily_throughput": {
      "type": "number"
    },
    "delivery_window": {
      "type": "string"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Sender ID Type

This is an immutable resource that represents the list of supported sender types that an be associated with a sender id.

Resource attributes:

id (string): Unique id of the address type
name (string): Name of the address type
description (string): human readable description of the sender address type
capabilities (string): Message types allowed on the sender ids from of this type- SMS, MMS, EMAIL, etc
allowed_mime_types (string): content type allowed on the sender id. This is a coma delimited list of MIME types. If the list is empty, all MIME types except for the blocked ones are allowed
blocked_mime_types (string): content type explicitly blocked on the sender id type. This is a coma delimited list of content types on the sender id.
gateway_id (string): this is the id of the gateway / connector to the downstream system that will handle the message delivery. The known gateways/connectors and the respective connection parameters for the gateway are configured separately.
credential_parameter_list (Array): (string): The is an array of string arrays. There is one array per message delivery provider (e.g. for push type the providerer can be APN, GCN) with the paramaters that are required in the SenderID credentials field for this provider.
created_date (string): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/messaging/sender_id_types get

get
Returns the list of supported sender address types

Returns the list of supported sender address types

Request
Response

Query Parameters

id: (string)
Filter
name: (string)
Filter
capabilities: (string)
Filter
allowed_mime_types: (string)
Filter
blocked_mime_types: (string)
Filter
credential_parameter_list: (string)
Filter
last_updated_date: (date)
Filter
version_number: (integer)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Sender ID Type List",
  "type": "array",
  "items": {
    "title": "Sender ID Type",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "capabilities": {
        "type": "string"
      },
      "allowed_mime_types": {
        "type": "string"
      },
      "blocked_mime_types": {
        "type": "string"
      },
      "gateway_id": {
        "type": "string"
      },
      "credential_parameter_list": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "created_date": {
        "type": "string"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/sender_id_types/{Type_ID} get

The sender ID type resource associated with the provided ID

get
Returns the current version of the specified type

Returns the current version of the specified type

Request
Response

URI Parameters

Type_ID: required (string)
This is the unique identifier of the Type resource.

Query Parameters

id: (string)
Filter
name: (string)
Filter
capabilities: (string)
Filter
allowed_mime_types: (string)
Filter
blocked_mime_types: (string)
Filter
credential_parameter_list: (string)
Filter
last_updated_date: (date)
Filter
version_number: (integer)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Sender ID Type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "capabilities": {
      "type": "string"
    },
    "allowed_mime_types": {
      "type": "string"
    },
    "blocked_mime_types": {
      "type": "string"
    },
    "gateway_id": {
      "type": "string"
    },
    "credential_parameter_list": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "created_date": {
      "type": "string"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Message Template

Message Templates can be created and associated with a sender id A message can then be sent with the corresponding name-value pairs to fill in the template. A sender id can be configured to enforce template use so that only messages that use a template can be sent on that sender id To use a template, the message body will contain a special content type with a list of name value pairs as the content.

Resource attributes:

id (string): The identifier

designation (string): The template is used either for VALIDATOR or as an actual TEMPLATE.

VALIDATOR type templates will be associated with a sender id and any message that is submitted to a sender ID that has some VALIDATOR templates associated with it will be checked against the template.

TEMPLATE type templates are used to send messages. in such case the message request body will indicate with template to apply and the message processing will use the template body and apply conversion of applicable keywords to create the actual message body.

NOTE- validator type templates can not be modified by the customer where the message template is associated with a shared sender id

name (string): The name of the template.
pattern (string): template pattern can be used to enforce compliancy of the message body with the submitted program brief. The template pattern allows also to use the templates to form the message body by using the template pattern and replacing the keywords in the pattern with the values of submitted keywords in the message send from the sender id
application_id (integer): ID of the application that has created the resource
created_date (date): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/messaging/message_templates get post

get
Returns the list of message templates

Returns the list of message templates

Request
Response

Query Parameters

id: (string)
Filter
designation: (string)
Filter
name: (string)
Filter
pattern: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message Template List",
  "type": "array",
  "items": {
    "title": "Message Template",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "designation": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "pattern": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Template Resource. All mandatory fields must be present

Creates a new Template Resource. All mandatory fields must be present

Request
Response

Body

Type: application/json

Form Parameters

designation: (string)
name: (string)
pattern: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/message_templates/{Template_ID} get post delete put

The Message Template resource associated with the provided ID

get
Returns the current version of the specified Template

Returns the current version of the specified Template

Request
Response

URI Parameters

Template_ID: required (string)
This is the unique identifier of the Template resource.

Query Parameters

id: (string)
Filter
designation: (string)
Filter
name: (string)
Filter
pattern: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message Template",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "designation": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "pattern": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the message template ID - only present attributes will be updated

Updates the message template ID - only present attributes will be updated

Request
Response

URI Parameters

Template_ID: required (string)
This is the unique identifier of the Template resource.

Body

Type: application/json

Form Parameters

designation: (string)
name: (string)
pattern: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Template resource with the specified ID

Deletes the Template resource with the specified ID

Request
Response

URI Parameters

Template_ID: required (string)
This is the unique identifier of the Template resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

put
Replaces the specific template ID. All mandatory fields must be present.

Replaces the specific template ID. All mandatory fields must be present.

Request
Response

URI Parameters

Template_ID: required (string)
This is the unique identifier of the Template resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters

designation: (string)
name: (string)
pattern: (string)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Sender ID

A Sender Address is a specific address (SMS short code, Integer code, email address, facebook account ID, etc.) that an Application can send messages from or receive messages to. The Sender Address must be provisioned with the SCG system before it can be used. Once a Sender Address has been provisioned it can be added to a Channel and messages can by sent using the Channel. Alternatively messages can be sent from a sender id without a channel. Sender addresses are customer specific - a customer will be able to access only his own sender addresses

Resource attributes:

id (string): unique id of the sender address
parent_id (string): for shared short codes, this is a reference to the system sender id that is associated with this preprovisioned address. Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was used to create customer version of the sender id
name (string): name of the sender address

ownership (string): this field determines the ownership category of a shortcode. Applies only for SMS type of sender id's. Following values are allowed-

- PRIVATE -> represents a short code that is private for use by one company only

- SHARED -> represents a short code that is owned by Syniverse and where multiple customers can use it. When a customer wants to use a SHARED sender id, a new PRIVATE sender address will be created with parent sender id set to the SHARED sender id

- PREPROVISIONED -> represents an address that is owned by Syniverse and can be selected by a customer. Upon a customer selecting a preprovisioned sender address, new sender id document as a copy of the PREPROVISIONED document is created, with state PRIVATE and parent_id pointing the original PREPROVISIONED sender address. The PREPROVISIONED sender address changes ownership to PURCHASED. Once the PRIVATE sender address, pointing to the PURCHASED is deleted, the PURCHASED sender changes its ownership back to PREPROVISIONED.

- PURCHASED -> PREPROVISIONED sender address, currently occupied by a customer.

class_id (string): reference to the sender address class that determines the priority and throughput of the configured sender id
type_id (string): reference the sender address type that determines the data types allowed on the sender id and identifies the gateway used to deliver the messages

state (string): represents the sender address status. Following values are allowed-

- PENDING_IMPLEMENTATION

- IMPLEMENTED

- ATIVE

- INACTIVE

- BROKEN

- PENDING_DELETE

For each sender address that require provisioning, when a sender address is requested, the initial status will be 'pending implementation'

address (string): The sender address. The address must correspond to the sender address type. For a2p sms this will be the shortcode or Integercode, for emails this will be the email address etc … For push this is a unique application name. This name will be used in contacts to identify the application specific push registration ids for a particular user.
content_type (string): the content of this field is specific the sender type / gateway associated with this sender
message_templates (Array): (string): A list of template ids that apply to this sender address. If more than one template applies, the elements will be separated by a coma.
country (string): The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
operators (Array): (string): A list of carriers who are confirmed to have provisioned the sender address. This will be a coma separate list of SPIDs. The values are managed by Syniverse and not editable by the customer
credentials (string): Anarray of inline JSON objecst with a list of name, value pairs that contain the credential and configuration values need to use this sender ID. There is one object in the array per message delivery provider that will be used for delivery messages with this sender ID. For example, the array may contain one entry for APN and one entry for GCN.
two_way_required (string): represents customer requested features of the sender id - if set to YES, means customer expects the sender id to support replies to an address
keep_sender_address (string): represents customer requested features of the sender id - if set to YES, means customer expects the sender id to be preserved
dr_required (string): represents customer requested features of the sender id - if set to YES, means customer expects the sender id to support DR
consent_managed_by (string): Possible values- USER, SCG. Default- USER.
capabilities (Array): (string): Message types allowed on the sender ids from of this type- SMS, MMS, EMAIL, etc
check_white_list (boolean): If set, sending via this sender ID is limited to recipients present in the customer's white list.
application_id (integer): ID of the application that has created the resource
created_date (date): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimistic locking
billing (string): billing info

/messaging/sender_ids get post

get
Returns the list of matching sender addresses

Returns the list of matching sender addresses

Request
Response

Query Parameters

id: (string)
Filter
parent_id: (string)
Filter
name: (string)
Filter
ownership: (string)
Filter
class_id: (string)
Filter
type_id: (string)
Filter
state: (string)
Filter
country: (string)
Filter
operators: (string)
Filter
two_way_required: (string)
Filter
keep_sender_address: (string)
Filter
dr_required: (string)
Filter
consent_managed_by: (string)
Filter
capabilities: (string)
Filter
check_white_list: (boolean)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Sender ID List",
  "type": "array",
  "items": {
    "title": "Sender ID",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "parent_id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "ownership": {
        "type": "string"
      },
      "class_id": {
        "type": "string"
      },
      "type_id": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "address": {
        "type": "string"
      },
      "content_type": {
        "type": "string"
      },
      "message_templates": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "country": {
        "type": "string"
      },
      "operators": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "credentials": {
        "type": "string"
      },
      "two_way_required": {
        "type": "string"
      },
      "keep_sender_address": {
        "type": "string"
      },
      "dr_required": {
        "type": "string"
      },
      "consent_managed_by": {
        "type": "string"
      },
      "capabilities": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "check_white_list": {
        "type": "boolean"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      },
      "billing": {
        "type": "string"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Sender ID Resource

Creates a new Sender ID Resource

Request
Response

Body

Type: application/json

Form Parameters

parent_id: (string)
name: (string)
ownership: (string)
class_id: (string)
type_id: (string)
state: (string)
address: (string)
content_type: (string)
message_templates: (string)
country: (string)
operators: (string)
credentials: (string)
two_way_required: (string)
keep_sender_address: (string)
dr_required: (string)
consent_managed_by: (string)
capabilities: (string)
check_white_list: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/sender_ids/purchase post

Customer purchase PREPROVISIONED sender address

post
Creates a new Sender ID Resource, copy of specified PREPROVISIONED Sender ID, which becomes PURCHASED until the private copy is deleted

Creates a new Sender ID Resource, copy of specified PREPROVISIONED Sender ID, which becomes PURCHASED until the private copy is deleted

Request
Response

Body

Type: application/json

Form Parameters

parent_id: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/sender_ids/{Sender_ID} get post delete

The Sender Id resource associated with the provided ID

get
Returns the current version of the specified Sender ID

Returns the current version of the specified Sender ID

Request
Response

URI Parameters

Sender_ID: required (string)
This is the unique identifier of the Sender resource.

Query Parameters

id: (string)
Filter
parent_id: (string)
Filter
name: (string)
Filter
ownership: (string)
Filter
class_id: (string)
Filter
type_id: (string)
Filter
state: (string)
Filter
country: (string)
Filter
operators: (string)
Filter
two_way_required: (string)
Filter
keep_sender_address: (string)
Filter
dr_required: (string)
Filter
consent_managed_by: (string)
Filter
capabilities: (string)
Filter
check_white_list: (boolean)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Sender ID",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "parent_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "ownership": {
      "type": "string"
    },
    "class_id": {
      "type": "string"
    },
    "type_id": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "content_type": {
      "type": "string"
    },
    "message_templates": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "country": {
      "type": "string"
    },
    "operators": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "credentials": {
      "type": "string"
    },
    "two_way_required": {
      "type": "string"
    },
    "keep_sender_address": {
      "type": "string"
    },
    "dr_required": {
      "type": "string"
    },
    "consent_managed_by": {
      "type": "string"
    },
    "capabilities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "check_white_list": {
      "type": "boolean"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    },
    "billing": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the sender ID - only present attributes will be updated

Updates the sender ID - only present attributes will be updated

Request
Response

URI Parameters

Sender_ID: required (string)
This is the unique identifier of the Sender resource.

Body

Type: application/json

Form Parameters

parent_id: (string)
name: (string)
ownership: (string)
class_id: (string)
type_id: (string)
state: (string)
address: (string)
content_type: (string)
message_templates: (string)
country: (string)
operators: (string)
credentials: (string)
two_way_required: (string)
keep_sender_address: (string)
dr_required: (string)
consent_managed_by: (string)
capabilities: (string)
check_white_list: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Sender ID resource with the specified ID

Deletes the Sender ID resource with the specified ID

Request
Response

URI Parameters

Sender_ID: required (string)
This is the unique identifier of the Sender resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Channel

Channels represent a group of sender addresses. Channels are created to create a mechanism to deliver messages over different media (if sender addresses of different type are used in a channel) or to increase throughput (by adding multiple sender ids to a single channel).

Resource attributes:

id (string): The channel identifier, allocated by SCG when channel is created
name (string): User Specified Name of the Channel
priority (string): Determines the chgannel priority- high, normal or low. SCG will deliver to target system first for messages in high priority channels, then normal and at the end low priority. Message size does not affect the message priority
description (string): Description of the Channel
ownership (string): SHARED/PRIVATE/PUBLIC
application_id (integer): ID of the application that has created the resource
created_date (date): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/messaging/channels get post

get
Returns the list of matching Channels

Returns the list of matching Channels

Request
Response

Query Parameters

id: (string)
Filter
name: (string)
Filter
priority: (string)
Filter
description: (string)
Filter
ownership: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Channel List",
  "type": "array",
  "items": {
    "title": "Channel",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "priority": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "ownership": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Channel Resource

Creates a new Channel Resource

Request
Response

Body

Type: application/json

Form Parameters

name: (string)
priority: (string)
description: (string)
ownership: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/channels/{Channel_ID} get post delete put

The Channel resource associated with the provided ID

get
Returns the current version of the specified Channel

Returns the current version of the specified Channel

Request
Response

URI Parameters

Channel_ID: required (string)
This is the unique identifier of the Channel resource.

Query Parameters

id: (string)
Filter
name: (string)
Filter
priority: (string)
Filter
description: (string)
Filter
ownership: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Channel",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "priority": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "ownership": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the channel ID - only present attributes will be updated

Updates the channel ID - only present attributes will be updated

Request
Response

URI Parameters

Channel_ID: required (string)
This is the unique identifier of the Channel resource.

Body

Type: application/json

Form Parameters

name: (string)
priority: (string)
description: (string)
ownership: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Channel resource with the specified ID

Deletes the Channel resource with the specified ID

Request
Response

URI Parameters

Channel_ID: required (string)
This is the unique identifier of the Channel resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

put
Replaces the specific Channel ID. All mandatory fields must be present.

Replaces the specific Channel ID. All mandatory fields must be present.

Request
Response

URI Parameters

Channel_ID: required (string)
This is the unique identifier of the Channel resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters

name: (string)
priority: (string)
description: (string)
ownership: (string)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/channels/{Channel_ID}/sender_ids get post delete

The sender IDs associated with the channel

get
The sender IDs associated with the channel

The sender IDs associated with the channel

Request
Response

URI Parameters

Channel_ID: required (string)
This is the unique identifier of the Channel resource.

Query Parameters

id: (string)
Filter
parent_id: (string)
Filter
name: (string)
Filter
ownership: (string)
Filter
class_id: (string)
Filter
type_id: (string)
Filter
state: (string)
Filter
country: (string)
Filter
operators: (string)
Filter
two_way_required: (string)
Filter
keep_sender_address: (string)
Filter
dr_required: (string)
Filter
consent_managed_by: (string)
Filter
capabilities: (string)
Filter
check_white_list: (boolean)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Sender ID List",
  "type": "array",
  "items": {
    "title": "Sender ID",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "parent_id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "ownership": {
        "type": "string"
      },
      "class_id": {
        "type": "string"
      },
      "type_id": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "address": {
        "type": "string"
      },
      "content_type": {
        "type": "string"
      },
      "message_templates": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "country": {
        "type": "string"
      },
      "operators": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "credentials": {
        "type": "string"
      },
      "two_way_required": {
        "type": "string"
      },
      "keep_sender_address": {
        "type": "string"
      },
      "dr_required": {
        "type": "string"
      },
      "consent_managed_by": {
        "type": "string"
      },
      "capabilities": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "check_white_list": {
        "type": "boolean"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      },
      "billing": {
        "type": "string"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Add sender_id(s) to the channel

Add sender_id(s) to the channel

Request
Response

URI Parameters

Channel_ID: required (string)
This is the unique identifier of the Channel resource.

Body

Type: application/json

Form Parameters

parent_id: (string)
name: (string)
ownership: (string)
class_id: (string)
type_id: (string)
state: (string)
address: (string)
content_type: (string)
message_templates: (string)
country: (string)
operators: (string)
credentials: (string)
two_way_required: (string)
keep_sender_address: (string)
dr_required: (string)
consent_managed_by: (string)
capabilities: (string)
check_white_list: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Remove a sender_id from the channel

Remove a sender_id from the channel

Request
Response

URI Parameters

Channel_ID: required (string)
This is the unique identifier of the Channel resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Message

A Message resource is created for every MO or MT message that is processed by SCG. For MT messages, there is an Message created for every recipient of the corresponding message request. For MO messages there is one message created. This resource is read only to an application.

Resource attributes:

id (string): Unique identifier
message_request_id (string): The unique id of the associated message request resource.
external_transaction_ids (string): This is list of id-s (one for every fragment) issued for this message by the downstream messaging system.
external_message_request_id (string): Application provided unique tracking ID for the message. Can be used as an alternative key in query methods.
conversation_id (string): The identifier of the conversation for conversation threading.
campaign_id (string): The campaign id- A unique identifier for a particular messaging campaign or program
direction (string): Message direction- MO for received messages and MT sent messages
customer_sender_id (string): The sender_id associated with the message delivery channel. For MT messages this will be the sender_id used to deliver the message. For MO messages this will be the sender_id corresponding to the downstream system which generated the message (determined by SCG based on the from/to address accordingly)
from_address (string): The sender address.
to_address (string): The recipient address.
state (string): The status of the message to this recipient.

  Valid values for MT messages are-

  - CREATED (message was created and is in the queue of SCG)

  - SENT (message was sent to the outbound delivery system)

  - DELIVERED (message was delivered to end-device of the user)

  - READ (message was read by the user)

  - CONVERTED (message was converted i.e. end user took action upon message)

  - FAILED (message delivery failed)

  - EXPIRED (message was too old to be sent)

  - SCHEDULED (message is created but not submitted for sending)

  - TEST (message was created but the request was a test request)

  - PAUSED (message was created but the request was to pause before delivery)

  - DELETED 



  SCG will automatically set the status of the message to converted when the message contains a 'tracked' URL and the link was clicked by the recipient.

  Alternatively the customer also externally can track conversion and could update the message status put applying the PUT method and specifying status = CONVERTED and the conversion timestamp



  Valid values for MO Messages are-

  - RECEIVED (received at SCG)

  - PROCESSED (when the customer has accessed the message and updated the status)

  - DELETED (when the message was deleted by the customer)

failure_code (string): INVALID_RECIPIENT, NO_CONSENT, OTHER
failure_details (string): text description that gives more detail on failed messages
subject (string): Subject of the message.
body (string): The message body as sent to the recipient.
sent_date (date): The timestamp when the message was submitted to downstream system for delivery
delivered_date (date): The timestamp when the message has been delivered, corresponds to DR date.
converted_date (date): The timestamp when the message was converted. This will be set automatically by SCG for messages with link tracking. For external tracking, the customer must provide the converted timestamp
conversion_info_source (string): Supplies information where the conversion information comes from. SCG/URL means the message was marked as converted by the link tracking service. For customer converted messages, the content of this attribute is determined by the customer and must be provided on the PUT request which marks the message as 'converted'
reply_to (string): The Message ID of a previously delivered message which the current message is a reply to.
attachments (Array): (string): A list of attachment IDs which are associated with this message.
scheduled_delivery_time (string): The date and time that this message should be delivered. This is the user specific time as calculated by the SCG based on the destination time zone and requested time zone calculation.
expiry_time (date): This is the timestamp after which the messages will no Integerer be sent to the downstream system for delivery
type (string): The message type (SMS, MMS, PSH)
message_delivery_provider (string): The delivery provider used for this message (APN, GCM)
contact-id (string): The ID of the contact (if any) this message was sent to
price (number): The message cost.
application_id (integer): ID of the application that has created the resource
created_date (date): The timestamp when the message was created, which corresponds to the time when the bulk message POST was done by the client.
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking
language (string): Language this message was translated to
failedTranslation (string): The reason that translate failed for this message

/messaging/messages get post

get
Returns the list of messages matching filter criteria

Returns the list of messages matching filter criteria

Request
Response

Query Parameters

id: (string)
Filter
message_request_id: (string)
Filter
external_transaction_ids: (string)
Filter
external_message_request_id: (string)
Filter
conversation_id: (string)
Filter
campaign_id: (string)
Filter
direction: (string)
Filter
customer_sender_id: (string)
Filter
from_address: (string)
Filter
to_address: (string)
Filter
state: (string)
Filter
failure_code: (string)
Filter
subject: (string)
Filter
body: (string)
Filter
sent_date: (date)
Filter
delivered_date: (date)
Filter
converted_date: (date)
Filter
reply_to: (string)
Filter
scheduled_delivery_time: (string)
Filter
expiry_time: (date)
Filter
type: (string)
Filter
message_delivery_provider: (string)
Filter
contact-id: (string)
Filter
price: (number)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message List",
  "type": "array",
  "items": {
    "title": "Message",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "message_request_id": {
        "type": "string"
      },
      "external_transaction_ids": {
        "type": "string"
      },
      "external_message_request_id": {
        "type": "string"
      },
      "conversation_id": {
        "type": "string"
      },
      "campaign_id": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      },
      "customer_sender_id": {
        "type": "string"
      },
      "from_address": {
        "type": "string"
      },
      "to_address": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "failure_code": {
        "type": "string"
      },
      "failure_details": {
        "type": "string"
      },
      "subject": {
        "type": "string"
      },
      "body": {
        "type": "string"
      },
      "sent_date": {
        "type": "date"
      },
      "delivered_date": {
        "type": "date"
      },
      "converted_date": {
        "type": "date"
      },
      "conversion_info_source": {
        "type": "string"
      },
      "reply_to": {
        "type": "string"
      },
      "attachments": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "scheduled_delivery_time": {
        "type": "string"
      },
      "expiry_time": {
        "type": "date"
      },
      "type": {
        "type": "string"
      },
      "message_delivery_provider": {
        "type": "string"
      },
      "contact-id": {
        "type": "string"
      },
      "price": {
        "type": "number"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      },
      "language": {
        "type": "string"
      },
      "failedTranslation": {
        "type": "string"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Not allowed

Not allowed

Request
Response

Body

Type: application/json

Form Parameters

state: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/messages/{Message_ID} get post delete

The Message resource associated with the provided ID

get
Returns current version of the specified message

Returns current version of the specified message

Request
Response

URI Parameters

Message_ID: required (string)
This is the unique identifier of the Message resource.

Query Parameters

id: (string)
Filter
message_request_id: (string)
Filter
external_transaction_ids: (string)
Filter
external_message_request_id: (string)
Filter
conversation_id: (string)
Filter
campaign_id: (string)
Filter
direction: (string)
Filter
customer_sender_id: (string)
Filter
from_address: (string)
Filter
to_address: (string)
Filter
state: (string)
Filter
failure_code: (string)
Filter
subject: (string)
Filter
body: (string)
Filter
sent_date: (date)
Filter
delivered_date: (date)
Filter
converted_date: (date)
Filter
reply_to: (string)
Filter
scheduled_delivery_time: (string)
Filter
expiry_time: (date)
Filter
type: (string)
Filter
message_delivery_provider: (string)
Filter
contact-id: (string)
Filter
price: (number)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "message_request_id": {
      "type": "string"
    },
    "external_transaction_ids": {
      "type": "string"
    },
    "external_message_request_id": {
      "type": "string"
    },
    "conversation_id": {
      "type": "string"
    },
    "campaign_id": {
      "type": "string"
    },
    "direction": {
      "type": "string"
    },
    "customer_sender_id": {
      "type": "string"
    },
    "from_address": {
      "type": "string"
    },
    "to_address": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "failure_code": {
      "type": "string"
    },
    "failure_details": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "body": {
      "type": "string"
    },
    "sent_date": {
      "type": "date"
    },
    "delivered_date": {
      "type": "date"
    },
    "converted_date": {
      "type": "date"
    },
    "conversion_info_source": {
      "type": "string"
    },
    "reply_to": {
      "type": "string"
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "scheduled_delivery_time": {
      "type": "string"
    },
    "expiry_time": {
      "type": "date"
    },
    "type": {
      "type": "string"
    },
    "message_delivery_provider": {
      "type": "string"
    },
    "contact-id": {
      "type": "string"
    },
    "price": {
      "type": "number"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    },
    "language": {
      "type": "string"
    },
    "failedTranslation": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Customers can use POST method to set the status of the message. Allowed actions are -- MO - DELETED (from any state) or PROCESSED (from RECEIVED state)- MT - DELETED (from any state) or CONVERTED (from CREATED, SENT, DELIVERED or READ, CANCELED, SCHEDULED or PAUSED)When status update is sent by user the SCG will also update the according counts on related message request

Customers can use POST method to set the status of the message. Allowed actions are -- MO - DELETED (from any state) or PROCESSED (from RECEIVED state)- MT - DELETED (from any state) or CONVERTED (from CREATED, SENT, DELIVERED or READ, CANCELED, SCHEDULED or PAUSED)When status update is sent by user the SCG will also update the according counts on related message request

Request
Response

URI Parameters

Message_ID: required (string)
This is the unique identifier of the Message resource.

Body

Type: application/json

Form Parameters

state: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Updates the status of the message to DELETED

Updates the status of the message to DELETED

Request
Response

URI Parameters

Message_ID: required (string)
This is the unique identifier of the Message resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/messages/{Message_ID}/attachments get post

List of Attachment resources associated with the provided message ID

get
Returns the list of matching attachments

Returns the list of matching attachments

Request
Response

URI Parameters

Message_ID: required (string)
This is the unique identifier of the Message resource.

Query Parameters

id: (string)
Filter
name: (string)
Filter
type: (string)
Filter
size: (integer)
Filter
filename: (string)
Filter
state: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Attachment List",
  "type": "array",
  "items": {
    "title": "Attachment",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "size": {
        "type": "integer"
      },
      "filename": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Not allowed

Not allowed

Request
Response

URI Parameters

Message_ID: required (string)
This is the unique identifier of the Message resource.

Body

Type: application/json

Form Parameters

name: (string)
type: (string)
filename: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Message Request

Message Requests represent instances of messages which have been sent by Applications to Contacts.

Resource attributes:

id (string): The identifier

from (string): The channel or Sender Id over/from which the message is to be sent.

-To send from a sender ID, the ID should be prefixed with 'sender_id'.   

-To send from a channel the ID should be prfixed with 'channel-'.

conversation_id (string): The identifier of the conversation for conversation threading.
to (Array): (string): For MT messages this will be a list of one or more recipient addresses, contact ids, contact group ids
campaign_id (string): The customer provided campaign id.
program_id (string): doub
subject (string): The subject – a short summary of the message’s purpose.
application_id (string): ID of the application that has created the message request
external_id (string): Application provided unique tracking ID for the message. Can be used as an alternative key in query methods.
state (string): The status of the message request-

  - SUBMITTED

  - ACCEPTED

  - REJECTED

  - PREPARING (while in the preparing state, the recipient cont may increase with time i.e. SCG will keep track of the preparing step to allow polling on the resource to have user see progress)

  - TRANSMITTING (while in the transmission state, the sent count will be updates as the messages are being sent)

  - COMPLETED

  - PAUSED (SCG will go into this state after preparing if pause flag is set)

  - CANCELED Canceled (cancel can be requested at any time)



  NOTE- to resume paused messages, the status should be updated by customer from PAUSED to TRANSMITTING

attachments (Array): (string): A list of attachment IDs which are associated with this message.

body (string): This is the original message body as supplied by application, prior to keyword processing.

It can reference a message template and supply the variables assignments for use with a template or contain the actual message body

consent_requirement (string): Field indicating if the message delivery is dependent on the double optin for the recipient. Any contacts/destination MDNs that should receive this message but do not have double optin in associated with the sender id would not be delivered (message will be created but will be in 'failed' status and will not be sent to the recipient). Values are-
```
- OPT_IN (message will be sent only if user explicitly opted in)

- OPT_OUT (message will be sent unless user explicitly opted out)

- NONE (message will be sent irrespectively of optin status)
```
criteria (string): The criteria string which was used in the bulk transmission, if any.
recipient_ count (integer): The number of contacts satisfying the criteria (or in the contact group) who have an address on the channel the bulk message is targeted for.
sent_count (integer): The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
delivered_count (integer): The number of messages sent for which some form of delivery receipt confirmation has been received. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
read_count (integer): The number of messages sent for which some form of delivery receipt confirmation has been received. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
converted_count (integer): The number of messages where conversion has been confirmed. This will apply for messages with URL where the application requested a link track. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
canceled_count (integer): The number of messages that have been created but not sent because the message request was canceled
failed_count (integer): The number of messages that have expired or have failed delivery
scheduled_delivery_time (date): The date and time that this message should be delivered.

scheduled_delivery_time_zone (string): Determines what time zone to apply to the scheduled delivery time-

- UTC- means that the scheduled delivery time as supplied in the request is expressed in UTC time

- LOCAL- means that the scheduled delivery time as supplied in the request is expressed in LOCAL recipient time. The time zone of the recipient is determined by SCG automatically based on-

    (1) actual location of the user (if LBS active and location known)

    (2) zip code associated with the user

    (3) MDN of the user (based on country)

expiry_time (date): This is the timestamp after which the messages resulting from the message request should no Integerer be sent.
test_message_flag (boolean): If this flag is set to “TRUE” then this will be processed and Out bound messages will be created but the messages will not be delivered to the clients.
pause_before_transmit (boolean): This is a flag that tells SCG to generate the messages but not to deliver them.
pause_expiry_time (string): This is the timestamp after which all paused messages will expire and will be removed from the outbound queue. The maximum expiry time is 24h. If application creates a message request with Integerer pause expiry time, the message request will fail
price_threshold (integer): The price threshold for messages in this request
sender_id_sort_criteria (Array): (string): Priority list of SenderId selection criteria (DELIVERY_ADDRESS, PRICE)
contact_delivery_address_priority (Array): (string): Priority list of contact delivery addresses (MDN, PUSH)
created_date (date): For a MT message (one which was sent via this API), this indicates the time when the API was called to request message delivery. For a MO message, this is the point in time when the SCG was notified of the inbound message from the operator network/mediate channel.
last_updated_date (date): Timestamp of the last event associated with the message

version_number (integer): An ascending version number of the object. 1 upon creation, incremented by one for each modification done.

NOTE- unlike other resources in the messaging gateway, messages are not updated directly. Events happening to a message (sending, delivery receipts, replies, conversions ….) indirectly update the status and hence version number of the message.

src_language (string): Source language of the message. Defaults to 'en'
dst_language (string): Translate message to specified language. If unset, only messages to contacts with language preference will be translated.
translate (boolean): When translate is 'true' translation is enabled
translations_count (integer): Number of messages being successfully translated
translations_failed_count (integer): Number of messages where translations was attempted but failed.
translations_performed_count (integer): Number of actual translate requests sent to the translation engine. This is the billable number of translations.
content_type (string): The content type of the message request body.

/messaging/message_requests get post

get
Returns the list of message requests matching filter criteria

Returns the list of message requests matching filter criteria

Request
Response

Query Parameters

id: (string)
Filter
from: (string)
Filter
conversation_id: (string)
Filter
to: (string)
Filter
campaign_id: (string)
Filter
program_id: (string)
Filter
subject: (string)
Filter
application_id: (string)
Filter
external_id: (string)
Filter
state: (string)
Filter
scheduled_delivery_time: (date)
Filter
expiry_time: (date)
Filter
test_message_flag: (boolean)
Filter
pause_before_transmit: (boolean)
Filter
pause_expiry_time: (string)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message Request List",
  "type": "array",
  "items": {
    "title": "Message Request",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "from": {
        "type": "string"
      },
      "conversation_id": {
        "type": "string"
      },
      "to": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "campaign_id": {
        "type": "string"
      },
      "program_id": {
        "type": "string"
      },
      "subject": {
        "type": "string"
      },
      "application_id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "attachments": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "body": {
        "type": "string"
      },
      "consent_requirement": {
        "type": "string"
      },
      "criteria": {
        "type": "string"
      },
      "recipient_ count": {
        "type": "integer"
      },
      "sent_count": {
        "type": "integer"
      },
      "delivered_count": {
        "type": "integer"
      },
      "read_count": {
        "type": "integer"
      },
      "converted_count": {
        "type": "integer"
      },
      "canceled_count": {
        "type": "integer"
      },
      "failed_count": {
        "type": "integer"
      },
      "scheduled_delivery_time": {
        "type": "date"
      },
      "scheduled_delivery_time_zone": {
        "type": "string"
      },
      "expiry_time": {
        "type": "date"
      },
      "test_message_flag": {
        "type": "boolean"
      },
      "pause_before_transmit": {
        "type": "boolean"
      },
      "pause_expiry_time": {
        "type": "string"
      },
      "price_threshold": {
        "type": "integer"
      },
      "sender_id_sort_criteria": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "contact_delivery_address_priority": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      },
      "src_language": {
        "type": "string"
      },
      "dst_language": {
        "type": "string"
      },
      "translate": {
        "type": "boolean"
      },
      "translations_count": {
        "type": "integer"
      },
      "translations_failed_count": {
        "type": "integer"
      },
      "translations_performed_count": {
        "type": "integer"
      },
      "content_type": {
        "type": "string"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1012 - Error message contains details about the limit being exceeded - Message size exceeds system limit
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length
1020 - Invalid Tracking URL - The tracking URL that was provided is invalid

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new message requestThe API supports sending messages to a single recipient using the following recipient reference -- by providing the value of the contact_id in the to_address field- by providing the recipient address (email, phone number etc …) in the to_address field. For creation of multiple messages, three options are available -1. The list of recipients can be expressed by using either -- providing a list of ContactID’s separated by semicolon in the to_address field- providing a llist of recipient addresses separated by semicolon in the to_address field.2. The message can be sent to all of the contacts in a contact group by providing a contact_group_id in the contact_group_id field.3. The message can be sent to a dynamically (on demand) composed group of Contacts determined based on specified critria. In this case a single criteria field is provided containing a criteria expression. This criteria expression is explained in section 5.4. A message is sent in this case to each contact which satisfies the criteria and has an address accessible via the specified Sender Address If the application wants delivery receipts as the messages are delivered, an appropriate Event Handler can be established on the channel, and associated with the application. This will cause the delivery receipt callbacks to the application-specified URL as the messages sent by that application are delivered. Application can also check the status of messages via the GET APIs using the message_ids returned.

Creates a new message requestThe API supports sending messages to a single recipient using the following recipient reference -- by providing the value of the contact_id in the to_address field- by providing the recipient address (email, phone number etc …) in the to_address field. For creation of multiple messages, three options are available -1. The list of recipients can be expressed by using either -- providing a list of ContactID’s separated by semicolon in the to_address field- providing a llist of recipient addresses separated by semicolon in the to_address field.2. The message can be sent to all of the contacts in a contact group by providing a contact_group_id in the contact_group_id field.3. The message can be sent to a dynamically (on demand) composed group of Contacts determined based on specified critria. In this case a single criteria field is provided containing a criteria expression. This criteria expression is explained in section 5.4. A message is sent in this case to each contact which satisfies the criteria and has an address accessible via the specified Sender Address If the application wants delivery receipts as the messages are delivered, an appropriate Event Handler can be established on the channel, and associated with the application. This will cause the delivery receipt callbacks to the application-specified URL as the messages sent by that application are delivered. Application can also check the status of messages via the GET APIs using the message_ids returned.

Request
Response

Body

Type: application/json

Form Parameters

from: (string)
conversation_id: (string)
to: (string)
campaign_id: (string)
program_id: (string)
subject: (string)
application_id: (string)
external_id: (string)
attachments: (string)
body: (string)
consent_requirement: (string)
criteria: (string)
recipient_ count: (integer)
sent_count: (integer)
delivered_count: (integer)
read_count: (integer)
converted_count: (integer)
canceled_count: (integer)
src_language: (string)
dst_language: (string)
translate: (boolean)
content_type: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1012 - Error message contains details about the limit being exceeded - Message size exceeds system limit
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length
1020 - Invalid Tracking URL - The tracking URL that was provided is invalid

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/message_requests/{MessageRequest_ID} get post delete

The Message Request resource associated with the provided ID

get
Returns current version of the specified message request

Returns current version of the specified message request

Request
Response

URI Parameters

MessageRequest_ID: required (string)
This is the unique identifier of the MessageRequest resource.

Query Parameters

id: (string)
Filter
from: (string)
Filter
conversation_id: (string)
Filter
to: (string)
Filter
campaign_id: (string)
Filter
program_id: (string)
Filter
subject: (string)
Filter
application_id: (string)
Filter
external_id: (string)
Filter
state: (string)
Filter
scheduled_delivery_time: (date)
Filter
expiry_time: (date)
Filter
test_message_flag: (boolean)
Filter
pause_before_transmit: (boolean)
Filter
pause_expiry_time: (string)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message Request",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "from": {
      "type": "string"
    },
    "conversation_id": {
      "type": "string"
    },
    "to": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "campaign_id": {
      "type": "string"
    },
    "program_id": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "application_id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "body": {
      "type": "string"
    },
    "consent_requirement": {
      "type": "string"
    },
    "criteria": {
      "type": "string"
    },
    "recipient_ count": {
      "type": "integer"
    },
    "sent_count": {
      "type": "integer"
    },
    "delivered_count": {
      "type": "integer"
    },
    "read_count": {
      "type": "integer"
    },
    "converted_count": {
      "type": "integer"
    },
    "canceled_count": {
      "type": "integer"
    },
    "failed_count": {
      "type": "integer"
    },
    "scheduled_delivery_time": {
      "type": "date"
    },
    "scheduled_delivery_time_zone": {
      "type": "string"
    },
    "expiry_time": {
      "type": "date"
    },
    "test_message_flag": {
      "type": "boolean"
    },
    "pause_before_transmit": {
      "type": "boolean"
    },
    "pause_expiry_time": {
      "type": "string"
    },
    "price_threshold": {
      "type": "integer"
    },
    "sender_id_sort_criteria": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "contact_delivery_address_priority": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    },
    "src_language": {
      "type": "string"
    },
    "dst_language": {
      "type": "string"
    },
    "translate": {
      "type": "boolean"
    },
    "translations_count": {
      "type": "integer"
    },
    "translations_failed_count": {
      "type": "integer"
    },
    "translations_performed_count": {
      "type": "integer"
    },
    "content_type": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Customers can use POST method to CANCEL or resume a PAUSED request

Customers can use POST method to CANCEL or resume a PAUSED request

Request
Response

URI Parameters

MessageRequest_ID: required (string)
This is the unique identifier of the MessageRequest resource.

Body

Type: application/json

Form Parameters

from: (string)
conversation_id: (string)
to: (string)
campaign_id: (string)
program_id: (string)
subject: (string)
application_id: (string)
external_id: (string)
attachments: (string)
body: (string)
consent_requirement: (string)
criteria: (string)
recipient_ count: (integer)
sent_count: (integer)
delivered_count: (integer)
read_count: (integer)
converted_count: (integer)
canceled_count: (integer)
src_language: (string)
dst_language: (string)
translate: (boolean)
content_type: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Delete of a message request in one of final states sets the message request status to DELETED. Any other status will first apply CANCEL action and then set the status to DELETED

Delete of a message request in one of final states sets the message request status to DELETED. Any other status will first apply CANCEL action and then set the status to DELETED

Request
Response

URI Parameters

MessageRequest_ID: required (string)
This is the unique identifier of the MessageRequest resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/message_requests/{MessageRequest_ID}/messages get post

List of messages associated with the provided Message Request ID

get
Returns the list of matching attachments

Returns the list of matching attachments

Request
Response

URI Parameters

MessageRequest_ID: required (string)
This is the unique identifier of the MessageRequest resource.

Query Parameters

id: (string)
Filter
message_request_id: (string)
Filter
external_transaction_ids: (string)
Filter
external_message_request_id: (string)
Filter
conversation_id: (string)
Filter
campaign_id: (string)
Filter
direction: (string)
Filter
customer_sender_id: (string)
Filter
from_address: (string)
Filter
to_address: (string)
Filter
state: (string)
Filter
failure_code: (string)
Filter
subject: (string)
Filter
body: (string)
Filter
sent_date: (date)
Filter
delivered_date: (date)
Filter
converted_date: (date)
Filter
reply_to: (string)
Filter
scheduled_delivery_time: (string)
Filter
expiry_time: (date)
Filter
type: (string)
Filter
message_delivery_provider: (string)
Filter
contact-id: (string)
Filter
price: (number)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message List",
  "type": "array",
  "items": {
    "title": "Message",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "message_request_id": {
        "type": "string"
      },
      "external_transaction_ids": {
        "type": "string"
      },
      "external_message_request_id": {
        "type": "string"
      },
      "conversation_id": {
        "type": "string"
      },
      "campaign_id": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      },
      "customer_sender_id": {
        "type": "string"
      },
      "from_address": {
        "type": "string"
      },
      "to_address": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "failure_code": {
        "type": "string"
      },
      "failure_details": {
        "type": "string"
      },
      "subject": {
        "type": "string"
      },
      "body": {
        "type": "string"
      },
      "sent_date": {
        "type": "date"
      },
      "delivered_date": {
        "type": "date"
      },
      "converted_date": {
        "type": "date"
      },
      "conversion_info_source": {
        "type": "string"
      },
      "reply_to": {
        "type": "string"
      },
      "attachments": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "scheduled_delivery_time": {
        "type": "string"
      },
      "expiry_time": {
        "type": "date"
      },
      "type": {
        "type": "string"
      },
      "message_delivery_provider": {
        "type": "string"
      },
      "contact-id": {
        "type": "string"
      },
      "price": {
        "type": "number"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      },
      "language": {
        "type": "string"
      },
      "failedTranslation": {
        "type": "string"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Not allowed

Not allowed

Request
Response

URI Parameters

MessageRequest_ID: required (string)
This is the unique identifier of the MessageRequest resource.

Body

Type: application/json

Form Parameters

state: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Attachment

The reource used to store attachment meta-data and the Attachment ID that is used to upload and dow load the attachment content. In order to upload an attachment, and attachment resource must first be created. In order to upload or download content an access token must be obtained using the AccessToken resource. The AccessToken expires so a new AccessToken ust be obtained immediatly before content upload or download.

Content: HTTP GET and POST requests are used to upload an download content. In order to upload or download content an access token must be obtained using the AccessToken resource. A new AccessToken ust be obtained immediatly before content upload or download.

Content URL: The URL will contain the AccessToken with path: /scg-attachment/api/v1/messaging/attachments/{AccessToken}/content

To Uplaod Content: Use a POST request to the Content URL with content-type multipart/form-data. This should contain one part with content type matching the content of the attachment file.

To Downlad Content: Use a GET request to the Content URL.

Resource attributes:

id (string): Unique identifier
name (string): The name of the attachment (e.g. it’s filename or other non-generated identifier) The value of this field should be unique for a given message.
type (string): The MIME type of the attachment (if known)
size (integer): The size, in bytes, of the attachment body
filename (string): Original file name of the attachment
state (string): CREATED, UPLOADED
application_id (integer): ID of the application that has created the resource
created_date (date): For a MT message (one which was sent via this API), this indicates the time when the API was called to request message delivery. For a MO message, this is the point in time when the SCG was notified of the inbound message from the operator network/mediation channel.
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/messaging/attachments get post

get
Returns the list of matching attachments

Returns the list of matching attachments

Request
Response

Query Parameters

id: (string)
Filter
name: (string)
Filter
type: (string)
Filter
size: (integer)
Filter
filename: (string)
Filter
state: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Attachment List",
  "type": "array",
  "items": {
    "title": "Attachment",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "size": {
        "type": "integer"
      },
      "filename": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Attachment resource

Creates a new Attachment resource

Request
Response

Body

Type: application/json

Form Parameters

name: (string)
type: (string)
filename: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/attachments/{Attachment_ID} get post delete

The Attachment resource associated with the provided ID

get
Returns the current version of the specified Attachment

Returns the current version of the specified Attachment

Request
Response

URI Parameters

Attachment_ID: required (string)
This is the unique identifier of the Attachment resource.

Query Parameters

id: (string)
Filter
name: (string)
Filter
type: (string)
Filter
size: (integer)
Filter
filename: (string)
Filter
state: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Attachment",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "size": {
      "type": "integer"
    },
    "filename": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1019 - Attachment Too Big - Attachment content size exceeds system limits
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the specific attachment id - only supplied fields are updated

Updates the specific attachment id - only supplied fields are updated

Request
Response

URI Parameters

Attachment_ID: required (string)
This is the unique identifier of the Attachment resource.

Body

Type: application/json

Form Parameters

name: (string)
type: (string)
filename: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1019 - Attachment Too Big - Attachment content size exceeds system limits
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the content of the attachment

Deletes the content of the attachment

Request
Response

URI Parameters

Attachment_ID: required (string)
This is the unique identifier of the Attachment resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1019 - Attachment Too Big - Attachment content size exceeds system limits
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/attachments/{Attachment_ID}/access_tokens post

The attachment AccessToken associated with the provided ID

post
Create a new access token for the given attachment resource. While valid the token can be used to upload/download content for the given attachment resource

Create a new access token for the given attachment resource. While valid the token can be used to upload/download content for the given attachment resource

Request
Response

URI Parameters

Attachment_ID: required (string)
This is the unique identifier of the Attachment resource.

Body

Type: application/json

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Call

This resourse represents a Voice Call between two parties. The 'from' field indicates the Sender ID that is associated with the telephone number or address that the call originates the call. The 'to' field indicates the telephone number or address of the party that is being called.

Resource attributes:

id (string): The unique identifier for this resource.
external_id (string): The unique Id assigned by the application.
from (string): The Sender ID associated with this call.
from_address (string): The address associated with the Sender Id.
to (string): The called party's address.
to_address (string): The address that was used by the system for the called party. When the 'to' field spcifies somehting other than the address (e.g. contact ID) then this field will contain the actual address that was used.
answer_timeout (integer): The number of miliseconds that the service will wait for an answer.

state (string): The call's state-

- STARTED - The call is being setup.

- ACTIVE - The call is in progress.

- REJECTED - The called party did not answer.

- COMPLETED - The call is complete.

direction (string): The direction of the call-

- IN - This was an incoming call.

- OUT - This was an outgoing call.

start_time (date): The time the call was started.
answer_time (date): The time the call was answered.
end_time (Array): (string): The time the call was ended.
chargeable_duration (integer): The call duration in seconds.
bridge_id (string): The id of the bridge that is associated with this call.
failure_code (string): The failure code associated with this call if applicable.
failure_details (integer): The failure message associated with this call if applicable.
price (number): The total cost of the call.
created_date (date): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimistic locking

/calling/calls get post

get
Returns the list of Calls

Returns the list of Calls

Request
Response

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
from: (string)
Filter
from_address: (string)
Filter
to: (string)
Filter
to_address: (string)
Filter
answer_timeout: (integer)
Filter
state: (string)
Filter
direction: (string)
Filter
start_time: (date)
Filter
answer_time: (date)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Call List",
  "type": "array",
  "items": {
    "title": "Call",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "from": {
        "type": "string"
      },
      "from_address": {
        "type": "string"
      },
      "to": {
        "type": "string"
      },
      "to_address": {
        "type": "string"
      },
      "answer_timeout": {
        "type": "integer"
      },
      "state": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      },
      "start_time": {
        "type": "date"
      },
      "answer_time": {
        "type": "date"
      },
      "end_time": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "chargeable_duration": {
        "type": "integer"
      },
      "bridge_id": {
        "type": "string"
      },
      "failure_code": {
        "type": "string"
      },
      "failure_details": {
        "type": "integer"
      },
      "price": {
        "type": "number"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Call Resource

Creates a new Call Resource

Request
Response

Body

Type: application/json

Form Parameters

external_id: (string)
from: (string)
from_address: (string)
to: (string)
answer_timeout: (integer)
direction: (string)
bridge_id: (string)
failure_code: (string)
failure_details: (integer)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/calls/{Call_ID} get post delete

The Voice Call resource associated with the provided ID.

get
Returns the current version of the specified Call

Returns the current version of the specified Call

Request
Response

URI Parameters

Call_ID: required (string)
This is the unique identifier of the Call resource.

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
from: (string)
Filter
from_address: (string)
Filter
to: (string)
Filter
to_address: (string)
Filter
answer_timeout: (integer)
Filter
state: (string)
Filter
direction: (string)
Filter
start_time: (date)
Filter
answer_time: (date)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Call",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "from": {
      "type": "string"
    },
    "from_address": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "to_address": {
      "type": "string"
    },
    "answer_timeout": {
      "type": "integer"
    },
    "state": {
      "type": "string"
    },
    "direction": {
      "type": "string"
    },
    "start_time": {
      "type": "date"
    },
    "answer_time": {
      "type": "date"
    },
    "end_time": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "chargeable_duration": {
      "type": "integer"
    },
    "bridge_id": {
      "type": "string"
    },
    "failure_code": {
      "type": "string"
    },
    "failure_details": {
      "type": "integer"
    },
    "price": {
      "type": "number"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the Call - only present attributes will be updated

Updates the Call - only present attributes will be updated

Request
Response

URI Parameters

Call_ID: required (string)
This is the unique identifier of the Call resource.

Body

Type: application/json

Form Parameters

external_id: (string)
from: (string)
from_address: (string)
to: (string)
answer_timeout: (integer)
direction: (string)
bridge_id: (string)
failure_code: (string)
failure_details: (integer)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Call resource with the specified ID

Deletes the Call resource with the specified ID

Request
Response

URI Parameters

Call_ID: required (string)
This is the unique identifier of the Call resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/calls/{call_id}/play_dtmf post

This is used to play dtmf tones on a call.

post
Plays the specified DTMF tones.

Plays the specified DTMF tones.

Request
Response

URI Parameters

call_id: required (string)
This is the unique identifier of the call_id resource.

Body

Type: application/json

Form Parameters

dtmf_digits: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/calls/{call_id}/play_tts post

This is used to play text to speech on a call.

post
Plays the specified text using text to speach.

Plays the specified text using text to speach.

Request
Response

URI Parameters

call_id: required (string)
This is the unique identifier of the call_id resource.

Body

Type: application/json

Form Parameters

text: (string)
language: (string)
gender: (string)
voice: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/calls/{call_id}/play_audio post

This is used to play an audio file on a call.

post
Plays the specified audio file.

Plays the specified audio file.

Request
Response

URI Parameters

call_id: required (string)
This is the unique identifier of the call_id resource.

Body

Type: application/json

Form Parameters

source_type: (string)
source: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Bridge

This resource represents the bridge between 2 voice calls. The bridge has a list of Call resource IDs that are associated with it.

Resource attributes:

id (string): The unique identifier for this resource.
external_id (string): The unique Id assigned by the application.

state (string): The bridge state-

 - CREATED - The Bridge has been created.

- ACTIVE - The Bridge is active.

- HOLD - The Bridge in on hold.

- COMPLETED - The Bridge has been completed and is no longer active.

- ERROR - The bridge failed to be created or was ended due to an error.

bridge_audio (boolean): A boolean indicating if the Bridge is on hold. This is set to False to put the bridge on hold or set to true to take a bridge off of hold.
completed_time - date (date): The time that the Bridge was completed.
activated_time - date (date): The time that the bridge was activated.
created_date (date): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimistic locking

/calling/bridges get post

get
Returns the list of Bridges

Returns the list of Bridges

Request
Response

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
state: (string)
Filter
bridge_audio: (boolean)
Filter
completed_time - date: (date)
Filter
activated_time - date: (date)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Bridge List",
  "type": "array",
  "items": {
    "title": "Bridge",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "bridge_audio": {
        "type": "boolean"
      },
      "completed_time - date": {
        "type": "date"
      },
      "activated_time   - date": {
        "type": "date"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Bridge Resource

Creates a new Bridge Resource

Request
Response

Body

Type: application/json

Form Parameters

call_ids: (string)
bridge_audio: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/bridges/{Bridge_ID} get post delete

The Voice Call Bridge resource associated with the provided ID.

get
Returns the current version of the specified Bridge

Returns the current version of the specified Bridge

Request
Response

URI Parameters

Bridge_ID: required (string)
This is the unique identifier of the Bridge resource.

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
state: (string)
Filter
bridge_audio: (boolean)
Filter
completed_time - date: (date)
Filter
activated_time - date: (date)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Bridge",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "bridge_audio": {
      "type": "boolean"
    },
    "completed_time - date": {
      "type": "date"
    },
    "activated_time   - date": {
      "type": "date"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the Bridge - only present attributes will be updated

Updates the Bridge - only present attributes will be updated

Request
Response

URI Parameters

Bridge_ID: required (string)
This is the unique identifier of the Bridge resource.

Body

Type: application/json

Form Parameters

call_ids: (string)
bridge_audio: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Bridge resource with the specified ID

Deletes the Bridge resource with the specified ID

Request
Response

URI Parameters

Bridge_ID: required (string)
This is the unique identifier of the Bridge resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/bridges/{Bridge_ID}/calls get

The Voice Call resources that are associated with this Bridge.

get
Returns a list of Voice Call resources.

Returns a list of Voice Call resources.

Request
Response

URI Parameters

Bridge_ID: required (string)
This is the unique identifier of the Bridge resource.

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
from: (string)
Filter
from_address: (string)
Filter
to: (string)
Filter
to_address: (string)
Filter
answer_timeout: (integer)
Filter
state: (string)
Filter
direction: (string)
Filter
start_time: (date)
Filter
answer_time: (date)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Call List",
  "type": "array",
  "items": {
    "title": "Call",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "from": {
        "type": "string"
      },
      "from_address": {
        "type": "string"
      },
      "to": {
        "type": "string"
      },
      "to_address": {
        "type": "string"
      },
      "answer_timeout": {
        "type": "integer"
      },
      "state": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      },
      "start_time": {
        "type": "date"
      },
      "answer_time": {
        "type": "date"
      },
      "end_time": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "chargeable_duration": {
        "type": "integer"
      },
      "bridge_id": {
        "type": "string"
      },
      "failure_code": {
        "type": "string"
      },
      "failure_details": {
        "type": "integer"
      },
      "price": {
        "type": "number"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/bridges/{Bridge_ID}/play_tts post

This is used to play text to speech on a bridge.

post
Plays the specified text using text to speach.

Plays the specified text using text to speach.

Request
Response

URI Parameters

Bridge_ID: required (string)
This is the unique identifier of the Bridge resource.

Body

Type: application/json

Form Parameters

text: (string)
language: (string)
gender: (string)
voice: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/bridges/{Bridge_ID}/play_audio post

This is used to play an audio file on a bridge.

post
Plays the specified audio file.

Plays the specified audio file.

Request
Response

URI Parameters

Bridge_ID: required (string)
This is the unique identifier of the Bridge resource.

Body

Type: application/json

Form Parameters

source_type: (string)
source: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Conference

A Conference resource represents an audio bridge that hosts multiple conference members.

Resource attributes:

id (string): The unique identifier for this resource.
external_id (string): The uniqueu Id assigned by the application.
from (string): The calling party's address.

state (string): The conference's state-

 - created (the conference is created but has no members)

 - active (the conference is active and has members)

 - completed (the conference is completed and has no members)

created_time (date): The date the conference was created.
completed_time (date): The time the conference was ended.
active_members (integer): Number of active members in the conference.
hold (boolean): If true, all member can't hear or speak in the conference.
mute (boolean): If 'true', all member can't speak in the conference.

/calling/conferences get post

get
Returns the list of Conferences

Returns the list of Conferences

Request
Response

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
from: (string)
Filter
state: (string)
Filter
created_time: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Conference List",
  "type": "array",
  "items": {
    "title": "Conference",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "from": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "created_time": {
        "type": "date"
      },
      "completed_time": {
        "type": "date"
      },
      "active_members": {
        "type": "integer"
      },
      "hold": {
        "type": "boolean"
      },
      "mute": {
        "type": "boolean"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Conference Resource

Creates a new Conference Resource

Request
Response

Body

Type: application/json

Form Parameters

external_id: (string)
from: (string)
state: (string)
hold: (boolean)
mute: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/conferences/{Conference_ID} get delete

The Voice Conference resource associated with the provided ID.

get
Returns the current version of the specified Conference

Returns the current version of the specified Conference

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
from: (string)
Filter
state: (string)
Filter
created_time: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Conference",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "from": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "created_time": {
      "type": "date"
    },
    "completed_time": {
      "type": "date"
    },
    "active_members": {
      "type": "integer"
    },
    "hold": {
      "type": "boolean"
    },
    "mute": {
      "type": "boolean"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Conference resource with the specified ID

Deletes the Conference resource with the specified ID

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/conferences/{Conference_ID}/play_tts post

This is used to play text to speech in a conference.

post
Plays the specified text using text to speach.

Plays the specified text using text to speach.

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.

Body

Type: application/json

Form Parameters

text: (string)
language: (string)
gender: (string)
voice: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/conferences/{Conference_ID}/play_audio post

This is used to play an audio file in a conference.

post
Plays the specified audio file.

Plays the specified audio file.

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.

Body

Type: application/json

Form Parameters

source_type: (string)
source: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

ConferenceMember

Resource attributes:

id (string): The unique identifier for this resource.
external_id (string): The uniqueu Id assigned by the application.

state (string): The conference member's state-

 - active (the member is active)

 - completed (the member is completed)

join_tone (boolean): If true, a sound will be played when member is added to conference.
leaving_tone (boolean): If true, a sound will be played when member is quiting a conference.
hold (boolean): If true, all member can't hear or speak in the conference
mute (boolean): If 'true', all member can't speak in the conference
added_time (date): The time the resource was added to conference.
removed_time (date): The time the resource was removed from conference.
conference_id (string): Id of the conference this resource is associated to.
conference_external_id (string): The uniqueu Id assigned by the application to the conference this resource is associated to.

/calling/conferences/{Conference_ID}/members get post

get
Returns the list of ConferenceMembers for the specified Conference

Returns the list of ConferenceMembers for the specified Conference

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.

Query Parameters

id: (string)
Filter
state: (string)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ConferenceMember List",
  "type": "array",
  "items": {
    "title": "ConferenceMember",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "join_tone": {
        "type": "boolean"
      },
      "leaving_tone": {
        "type": "boolean"
      },
      "hold": {
        "type": "boolean"
      },
      "mute": {
        "type": "boolean"
      },
      "added_time": {
        "type": "date"
      },
      "removed_time": {
        "type": "date"
      },
      "conference_id": {
        "type": "string"
      },
      "conference_external_id": {
        "type": "string"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new ConferenceMember Resource

Creates a new ConferenceMember Resource

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.

Body

Type: application/json

Form Parameters

external_id: (string)
state: (string)
join_tone: (boolean)
leaving_tone: (boolean)
hold: (boolean)
mute: (boolean)
conference_external_id: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/conferences/{Conference_ID}/members/{Member_ID} get delete

The Voice Conference resource associated with the provided ID.

get
Returns the current version of the specified ConferenceMember

Returns the current version of the specified ConferenceMember

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.
Member_ID: required (string)
This is the unique identifier of the Member resource.

Query Parameters

id: (string)
Filter
state: (string)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ConferenceMember",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "join_tone": {
      "type": "boolean"
    },
    "leaving_tone": {
      "type": "boolean"
    },
    "hold": {
      "type": "boolean"
    },
    "mute": {
      "type": "boolean"
    },
    "added_time": {
      "type": "date"
    },
    "removed_time": {
      "type": "date"
    },
    "conference_id": {
      "type": "string"
    },
    "conference_external_id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the ConferenceMember resource with the specified ID

Deletes the ConferenceMember resource with the specified ID

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.
Member_ID: required (string)
This is the unique identifier of the Member resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/conferences/{Conference_ID}/members/{Member_ID}/play_tts post

This is used to play text to speech for a specific conference member.

post
Plays the specified text using text to speach.

Plays the specified text using text to speach.

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.
Member_ID: required (string)
This is the unique identifier of the Member resource.

Body

Type: application/json

Form Parameters

text: (string)
language: (string)
gender: (string)
voice: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/calling/conferences/{Conference_ID}/members/{Member_ID}/play_audio post

This is used to play an audio file for a specific conference member.

post
Plays the specified audio file.

Plays the specified audio file.

Request
Response

URI Parameters

Conference_ID: required (string)
This is the unique identifier of the Conference resource.
Member_ID: required (string)
This is the unique identifier of the Member resource.

Body

Type: application/json

Form Parameters

source_type: (string)
source: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Access Token

The AccessToken resource is used to manage tokens that are used for attachment uploads and downloads.

Resource attributes:

id (string): The unique id of the token
expiry_time (date): The UTC timestamp after which the token is no Integerer valid.
application_id (integer): ID of the application that has created the resource
created_date (date): The timestamp when the resource was created.
last_updated_date (date): The timestamp the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/access_tokens get post

get
Returns the list of matching AccessTokens

Returns the list of matching AccessTokens

Request
Response

Query Parameters

id: (string)
Filter
expiry_time: (date)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Token List",
  "type": "array",
  "items": {
    "title": "Access Token",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "expiry_time": {
        "type": "date"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Create a new access token for the given resource

Create a new access token for the given resource

Request
Response

Body

Type: application/json

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/access_tokens/{AccessToken_ID} get delete

The AccessToken associated with the provided ID

get
Returns the current version of the AccessToken associated with the provided ID

Returns the current version of the AccessToken associated with the provided ID

Request
Response

URI Parameters

AccessToken_ID: required (string)
This is the unique identifier of the AccessToken resource.

Query Parameters

id: (string)
Filter
expiry_time: (date)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Token",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "expiry_time": {
      "type": "date"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the AccessToken associated with the provided ID

Deletes the AccessToken associated with the provided ID

Request
Response

URI Parameters

AccessToken_ID: required (string)
This is the unique identifier of the AccessToken resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Contact Address Status

The contact address status resource is used to keep the current consent status of the contact address. The contact address status is customer specific i.e. the same address may be tracked in SCG separately for each customer.

Resource attributes:

id (string): Unique identifier, allocated by SCG at the time of address creation. This is a combination of an address type/value and sender id.
```
SCG will allocate a new address_status_id for any message sent or received from a new combination of sender id and address value/type
```
address_type (string): The address type- MDN (for phone numbers), EMAIL, SOCIAL, PUSH (…)
address (string): The actual value of the address. For SMS/MMS this will be the MDN.
sender_id (string): the sender id accociated with the address type/value

consent_status (string): this is the current optin status for the specific address / sender id. The possible values are-

- NONE (no optin or optout message received from the address on the specific sender id)

- OPTIN (user has explicitly opted in to the sender id)

- OPTOUT (user has explicitly opted out of the sender id)

- BLACKLIST (blacklisted address - will be treated as explicit OPTOUT)

- WHITELIST (whitelisted address - will be treated as explicit OPTIN)

NOTE- Whitelisted or blacklisted status can not be overwritten by the end-user by sending messages to the sender id. Such users can be only un-listed by changing the optin-status explicitly put POST to address status ID

application_id (integer): ID of the application that has created the resource
created_date (date): The creation date of the object.
last_updated_date (date): The last modification date of the object.
version_number (integer): An ascending version number of the object. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking.

/consent/contact_address_statuses get post

get
Returns the list of matching Contact Address Statues

Returns the list of matching Contact Address Statues

Request
Response

Query Parameters

id: (string)
Filter
address_type: (string)
Filter
address: (string)
Filter
sender_id: (string)
Filter
consent_status: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Address Status List",
  "type": "array",
  "items": {
    "title": "Contact Address Status",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "address_type": {
        "type": "string"
      },
      "address": {
        "type": "string"
      },
      "sender_id": {
        "type": "string"
      },
      "consent_status": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Contact Address Status resource. This will trigger the start of the consent flow for the given contact address.

Creates a new Contact Address Status resource. This will trigger the start of the consent flow for the given contact address.

Request
Response

Body

Type: application/json

Form Parameters

address_type: (string)
consent_status: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/consent/contact_address_statuses/{AddressStatus_ID} get post delete

The Contact Address Status resource associated with the provided ID

get
Returns the current version of the specified Contact Address Status History

Returns the current version of the specified Contact Address Status History

Request
Response

URI Parameters

AddressStatus_ID: required (string)
This is the unique identifier of the AddressStatus resource.

Query Parameters

id: (string)
Filter
address_type: (string)
Filter
address: (string)
Filter
sender_id: (string)
Filter
consent_status: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Address Status",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "address_type": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "sender_id": {
      "type": "string"
    },
    "consent_status": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Address Status Resource. This is allowed for User managed consent.

Creates a new Address Status Resource. This is allowed for User managed consent.

Request
Response

URI Parameters

AddressStatus_ID: required (string)
This is the unique identifier of the AddressStatus resource.

Body

Type: application/json

Form Parameters

address_type: (string)
consent_status: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Address Status Resource with the specified ID

Deletes the Address Status Resource with the specified ID

Request
Response

URI Parameters

AddressStatus_ID: required (string)
This is the unique identifier of the AddressStatus resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Contact Address History

The contact address status history resource is used to track the received keywords from a given contact address and the changes in the consent status of the contact address. The contact address status is customer specific i.e. the same address may be tracked in SCG separately for each customer.

Resource attributes:

id (string): Unique identifier, allocated by SCG at the time of the history record creation.
msisdn (string): The value of the contact's address. For SMS/MMS this will be the MDN.
sender_id (string): The sender id that MO/MT message was sent to/from

source (string): The source of the contact's consent status information-

- MESSAGE - when the consent status has changed as a result of a MO message sent by the contact (SCG managed consent)

- CARRIER  - when a blacklist file was provided by a carrier and loaded in

- COMPANY - when the user of SCG has supplied the information (USER managed consent)

status (string): The new consent status of the contact
timestamp (date): Timestamp indicating when the MO message that triggered the consent status change was received
message (string): The body of the actual MO message that triggered the consent status change
keyword (string): The keyword detected by the application
application_id (integer): ID of the application that has created the resource
created_date (date): The creation date of the object.
last_updated_date (date): The last modification date of the object.
version_number (integer): An ascending version number of the object. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking.

/consent/contact_address_history get

get
Returns the list of matching Contact Address History Resources

Returns the list of matching Contact Address History Resources

Request
Response

Query Parameters

id: (string)
Filter
msisdn: (string)
Filter
sender_id: (string)
Filter
source: (string)
Filter
status: (string)
Filter
timestamp: (date)
Filter
message: (string)
Filter
keyword: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Address History List",
  "type": "array",
  "items": {
    "title": "Contact Address History",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "msisdn": {
        "type": "string"
      },
      "sender_id": {
        "type": "string"
      },
      "source": {
        "type": "string"
      },
      "status": {
        "type": "string"
      },
      "timestamp": {
        "type": "date"
      },
      "message": {
        "type": "string"
      },
      "keyword": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Contact

A Contact represents a person/application/entity which the SCG communicates with on behalf of applications. Contacts do not send or receive messages directly via the Syniverse Messaging Gateway, but rather do so directly via the media channel. The distinction between Applications and Contacts is thus based on how the messaging is being performed. Applications (entities using the APIs to initiate messaging) send/receive messages from Contacts (entities which are not using the APIs to initiate messaging.)

Resource attributes:

id (string): Unique identifier, allocated by SCG at the time of contact creation
external_id (string): the id of the contact at the customer system. Can be used by customer to update the contacts
first_name (string): First name of customer
last_name (string): Last name of customer
birth_date (date): Customer birth date. YYYY-MM-DD
first_acquisition_date (date): The timestamp of the first customer acquisition - i.e. the date when the customer has been for the first time opted in to any program
last_acquisition_date (date): The timestamp of the last customer acquisition i.e. the date when the customer has for the last time sent an optin keyword or performed a doubleoptin
primary_mdn (string): The primary phone number of the customer. This is the number used to track the double optin for the customer
primary_addr_line1 (string): Details of customers primary address
primary_addr_line2 (string): Details of customers primary address
primary_addr_city (string): Details of customers primary address
primary_addr_zip (string): ZIP code of the customer primary address
primary_addr_state (string): Details of customers primary address
primary_email_addr (string): Customers primary email address
primary_addr_country (string): Customer primary address country
primary_social_handle (string): Customers primary social media ID

address_list (string): Stores all known addresses of the customer in a form of a JSON array. Each address in the array can have the following attributes-

- priority- priority of the address, 1 highest

- designation- specifies type of the address- home, work

- use- billing, shipping

- source- specifies where the address comes from, company specific

- status- status of the address- VALID_NEW, VALID_CONF, INVALID, EXPIRED

- line1- first address line

- line2- second address line

- city

- state

- province

- zip

- country

customer_account_list (string): Stores all known accounts of the customer in a form of a JSON array. Each account in the array can have the following attributes-

- priority- user defined account priority

- designation-  primary designation of the account- work, private …

- source- specifies where the address comes from, company specific

- status- status of the address- VALID_NEW, VALID_CONF, INVALID, EXPIRED

- type- email, social, web, loyalty

- username- the username in the account. This will be the membership id in loyalty programs or the email address for an email account

- domain- account domain. For example starwood.com

- access_token- the access token to the account where the account requires some oauth type authorization

NOTE- other attributes may be required/provided, based on the account type and domain.

customer_device_list (string): Stores all known customer devices in a form of a JSON array. Each account in the device can have the following attributes-

- priority- user defined account priority

- designation-  primary designation of the account- work, private …

- source- specifies where the address comes from, company specific

- status- status of the address- VALID_NEW, VALID_CONF, INVALID, EXPIRED

- msisdn

- carrier

- mac_address, 

- uuid

- imei 

- manufacturer- device manufacturer, for example Apple

- model- model of the device, for example iPhone 5s

- os- operating system of the device, for example iOS 8.3

NOTE- other attributes may be required/provided, based on the device type.

interest_list (string): Stores all known customer preferences in a form of a JSON array. Each preference can have the following attributes-

- code- interest code 

- name- interest name

- source- where the information was obtained

- score- how likely the information is, floating point value 0...1

demographic_list (string): Stores all known customer demographic in a form of a JSON array. Each demographic can have the following attributes-
```
- demographic name

- source- where the information was obtained

- score- how likely the information is, floating point value 0...1
```
extended_attributes (string): JSON string of all extended attributes of the customer. Any list of key-value pairs is supported. Also composite attributes can be stored.
fast_access (string): JSON object containing current values of fast access attributes
application_id (integer): ID of the application that has created the resource
created_date (date): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking
preferred_language (string): When translation is enabled, the message to this contact will be translated

voice_preference (boolean): This contac'ts preference setting for voice message delivery-

- NONE - no preference

- PREFER_VOICE - contact prefers voice if possible (voice capable sender ID available as message originator and is not rejected due to price or other policy)

- REQUIRE_VOICE - contact requires voice - selecting voice capable sender ID overrides price and other policies; message fails if voice sender ID is not available

/contacts get post

get
Returns the list of matching Contacts

Returns the list of matching Contacts

Request
Response

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
first_name: (string)
Filter
last_name: (string)
Filter
birth_date: (date)
Filter
first_acquisition_date: (date)
Filter
last_acquisition_date: (date)
Filter
primary_mdn: (string)
Filter
primary_addr_line1: (string)
Filter
primary_addr_line2: (string)
Filter
primary_addr_city: (string)
Filter
primary_addr_zip: (string)
Filter
primary_addr_state: (string)
Filter
primary_email_addr: (string)
Filter
primary_addr_country: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact List",
  "type": "array",
  "items": {
    "title": "Contact",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "first_name": {
        "type": "string"
      },
      "last_name": {
        "type": "string"
      },
      "birth_date": {
        "type": "date"
      },
      "first_acquisition_date": {
        "type": "date"
      },
      "last_acquisition_date": {
        "type": "date"
      },
      "primary_mdn": {
        "type": "string"
      },
      "primary_addr_line1": {
        "type": "string"
      },
      "primary_addr_line2": {
        "type": "string"
      },
      "primary_addr_city": {
        "type": "string"
      },
      "primary_addr_zip": {
        "type": "string"
      },
      "primary_addr_state": {
        "type": "string"
      },
      "primary_email_addr": {
        "type": "string"
      },
      "primary_addr_country": {
        "type": "string"
      },
      "primary_social_handle": {
        "type": "string"
      },
      "address_list": {
        "type": "string"
      },
      "customer_account_list": {
        "type": "string"
      },
      "customer_device_list": {
        "type": "string"
      },
      "interest_list": {
        "type": "string"
      },
      "demographic_list": {
        "type": "string"
      },
      "extended_attributes": {
        "type": "string"
      },
      "fast_access": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      },
      "preferred_language": {
        "type": "string"
      },
      "voice_preference": {
        "type": "boolean"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Contact Resource

Creates a new Contact Resource

Request
Response

Body

Type: application/json

Form Parameters

external_id: (string)
first_name: (string)
last_name: (string)
birth_date: (date)
first_acquisition_date: (date)
last_acquisition_date: (date)
primary_mdn: (string)
primary_addr_line1: (string)
primary_addr_line2: (string)
primary_addr_city: (string)
primary_addr_zip: (string)
primary_addr_state: (string)
primary_email_addr: (string)
primary_addr_country: (string)
primary_social_handle: (string)
address_list: (string)
customer_account_list: (string)
customer_device_list: (string)
interest_list: (string)
demographic_list: (string)
extended_attributes: (string)
preferred_language: (string)
voice_preference: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contacts/{Contact_ID} get post delete put

The Message Template resource associated with the provided ID

get
Returns the current version of the specified Contact

Returns the current version of the specified Contact

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
first_name: (string)
Filter
last_name: (string)
Filter
birth_date: (date)
Filter
first_acquisition_date: (date)
Filter
last_acquisition_date: (date)
Filter
primary_mdn: (string)
Filter
primary_addr_line1: (string)
Filter
primary_addr_line2: (string)
Filter
primary_addr_city: (string)
Filter
primary_addr_zip: (string)
Filter
primary_addr_state: (string)
Filter
primary_email_addr: (string)
Filter
primary_addr_country: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "birth_date": {
      "type": "date"
    },
    "first_acquisition_date": {
      "type": "date"
    },
    "last_acquisition_date": {
      "type": "date"
    },
    "primary_mdn": {
      "type": "string"
    },
    "primary_addr_line1": {
      "type": "string"
    },
    "primary_addr_line2": {
      "type": "string"
    },
    "primary_addr_city": {
      "type": "string"
    },
    "primary_addr_zip": {
      "type": "string"
    },
    "primary_addr_state": {
      "type": "string"
    },
    "primary_email_addr": {
      "type": "string"
    },
    "primary_addr_country": {
      "type": "string"
    },
    "primary_social_handle": {
      "type": "string"
    },
    "address_list": {
      "type": "string"
    },
    "customer_account_list": {
      "type": "string"
    },
    "customer_device_list": {
      "type": "string"
    },
    "interest_list": {
      "type": "string"
    },
    "demographic_list": {
      "type": "string"
    },
    "extended_attributes": {
      "type": "string"
    },
    "fast_access": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    },
    "preferred_language": {
      "type": "string"
    },
    "voice_preference": {
      "type": "boolean"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the specific contact

Updates the specific contact

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.

Body

Type: application/json

Form Parameters

external_id: (string)
first_name: (string)
last_name: (string)
birth_date: (date)
first_acquisition_date: (date)
last_acquisition_date: (date)
primary_mdn: (string)
primary_addr_line1: (string)
primary_addr_line2: (string)
primary_addr_city: (string)
primary_addr_zip: (string)
primary_addr_state: (string)
primary_email_addr: (string)
primary_addr_country: (string)
primary_social_handle: (string)
address_list: (string)
customer_account_list: (string)
customer_device_list: (string)
interest_list: (string)
demographic_list: (string)
extended_attributes: (string)
preferred_language: (string)
voice_preference: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Contact resource with the specified ID

Deletes the Contact resource with the specified ID

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

put
Replaces the specific contact

Replaces the specific contact

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters

external_id: (string)
first_name: (string)
last_name: (string)
birth_date: (date)
first_acquisition_date: (date)
last_acquisition_date: (date)
primary_mdn: (string)
primary_addr_line1: (string)
primary_addr_line2: (string)
primary_addr_city: (string)
primary_addr_zip: (string)
primary_addr_state: (string)
primary_email_addr: (string)
primary_addr_country: (string)
primary_social_handle: (string)
address_list: (string)
customer_account_list: (string)
customer_device_list: (string)
interest_list: (string)
demographic_list: (string)
extended_attributes: (string)
preferred_language: (string)
voice_preference: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contacts/{Contact_ID}/access_tokens get post

List of customer Contact Access Tokens

get
Returns the list of matching Contact Access Tokens

Returns the list of matching Contact Access Tokens

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.

Query Parameters

id: (string)
Filter
expiry_time: (date)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Token List",
  "type": "array",
  "items": {
    "title": "Access Token",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "expiry_time": {
        "type": "date"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new contact access token resource

Creates a new contact access token resource

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.

Body

Type: application/json

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contacts/{Contact_ID}/access_tokens/{Contact_Access_Token_Id} get delete put

The Contact Access Token resource associated with the provided ID

get
Returns the current version of the specified Contact Access Token

Returns the current version of the specified Contact Access Token

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.
Contact_Access_Token_Id: required (string)
This is the unique identifier of the Contact resource.

Query Parameters

id: (string)
Filter
expiry_time: (date)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Access Token",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "expiry_time": {
      "type": "date"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Contact Access Token resource with the specified ID

Deletes the Contact Access Token resource with the specified ID

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.
Contact_Access_Token_Id: required (string)
This is the unique identifier of the Contact resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

put
Replaces the specific contact application token

Replaces the specific contact application token

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.
Contact_Access_Token_Id: required (string)
This is the unique identifier of the Contact resource.

Body

Type: application/x-www-form-urlencoded

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Contact Application Token

This resouce stores an application token (e.g. Push Registration ID) that is associated with the given Contact. It also stores information about how this token is used such as the associated sender Id Address and the messaging system provider .

Resource attributes:

id (string): Unique identifier, allocated by SCG at the time of contact Application Token creation
sender_id_address (string): The address of the sender Id that is associated with this application.
message_delivery_provider (string): The code that indicates the message devliery provider (e.g. APN, GCN)
token (string): The token the user, application and device.
application_id (integer): ID of the application that has created the resource
created_date (date): The date the resource was created
last_update_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/contacts/{Contact_ID}/application_tokens get post

get
Returns the list of matching Contact Application Tokens

Returns the list of matching Contact Application Tokens

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.

Query Parameters

id: (string)
Filter
sender_id_address: (string)
Filter
message_delivery_provider: (string)
Filter
token: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_update_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Application Token List",
  "type": "array",
  "items": {
    "title": "Contact Application Token",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "sender_id_address": {
        "type": "string"
      },
      "message_delivery_provider": {
        "type": "string"
      },
      "token": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_update_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new contact application token resource

Creates a new contact application token resource

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.

Body

Type: application/json

Form Parameters

sender_id_address: (string)
message_delivery_provider: (string)
token: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contacts/{Contact_ID}/application_tokens/{Contact_Application_Token_Id} get post delete put

The Contact Application resource associated with the provided ID

get
Returns the current version of the specified Contact Application Token

Returns the current version of the specified Contact Application Token

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.
Contact_Application_Token_Id: required (string)
This is the unique identifier of the Contact resource.

Query Parameters

id: (string)
Filter
sender_id_address: (string)
Filter
message_delivery_provider: (string)
Filter
token: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_update_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Application Token",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "sender_id_address": {
      "type": "string"
    },
    "message_delivery_provider": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_update_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the specific contact application token

Updates the specific contact application token

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.
Contact_Application_Token_Id: required (string)
This is the unique identifier of the Contact resource.

Body

Type: application/json

Form Parameters

sender_id_address: (string)
message_delivery_provider: (string)
token: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Contact Application resource with the specified ID

Deletes the Contact Application resource with the specified ID

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.
Contact_Application_Token_Id: required (string)
This is the unique identifier of the Contact resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

put
Replaces the specific contact application token

Replaces the specific contact application token

Request
Response

URI Parameters

Contact_ID: required (string)
This is the unique identifier of the Contact resource.
Contact_Application_Token_Id: required (string)
This is the unique identifier of the Contact resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters

sender_id_address: (string)
message_delivery_provider: (string)
token: (string)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Fast Access

Fast access resource defines how to map complex (not indexed) attributes of a contact to fast access attributes which are indexed.

Resource attributes:

id (string): The unique id of a mapping rule
target_attribute (string): The name in the contact resource this mapping applies to- fast_access_1 .. fast_access_20.
target_attribute_name (string): The friendly name of the fast access attribute. The corresponding attribute will appear under the fast_access sb-object of the contact object. The name must be used for all contact updates. It can be used with filters like fast_access.
```
If not provided, the corresponding attribute will appear in the contact and filter criteria as is.
```
value_derivation_script (string): The rule - JSON Path expression _ on how to compute the value of the target attribute from the contact.
```
If not provided the corresponding attribute will be editable in the contact.
```
user_data (string): Data that the user can associate with an attribute, in case they want to do client side mapping instead of using target_attribute_name to do server side mapping of the attributes.
application_id (integer): ID of the application that has created the resource
created_date (date): The date the resource was created
last_updated_date (date): The data the resource was last changed
version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/contacts/fast_access get post

get
Returns list of matching Fast Access Rules

Returns list of matching Fast Access Rules

Request
Response

Query Parameters

id: (string)
Filter
target_attribute: (string)
Filter
target_attribute_name: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Fast Access List",
  "type": "array",
  "items": {
    "title": "Fast Access",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "target_attribute": {
        "type": "string"
      },
      "target_attribute_name": {
        "type": "string"
      },
      "value_derivation_script": {
        "type": "string"
      },
      "user_data": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Fast Access Rule resource

Creates a new Fast Access Rule resource

Request
Response

Body

Type: application/json

Form Parameters

target_attribute: (string)
target_attribute_name: (string)
value_derivation_script: (string)
user_data: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contacts/fast_access/{Rule_ID} get post delete

The Fact Acccess rule associated with the provided ID

get
Returns current version of the specified Fast Access Rule

Returns current version of the specified Fast Access Rule

Request
Response

URI Parameters

Rule_ID: required (string)
This is the unique identifier of the Rule resource.

Query Parameters

id: (string)
Filter
target_attribute: (string)
Filter
target_attribute_name: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Fast Access",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "target_attribute": {
      "type": "string"
    },
    "target_attribute_name": {
      "type": "string"
    },
    "value_derivation_script": {
      "type": "string"
    },
    "user_data": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates Fast Access Rule resource

Updates Fast Access Rule resource

Request
Response

URI Parameters

Rule_ID: required (string)
This is the unique identifier of the Rule resource.

Body

Type: application/json

Form Parameters

target_attribute: (string)
target_attribute_name: (string)
value_derivation_script: (string)
user_data: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the specified Fast Access Rule

Deletes the specified Fast Access Rule

Request
Response

URI Parameters

Rule_ID: required (string)
This is the unique identifier of the Rule resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Contact Group

This resource can represent a collection of Contacts meant to support bulk messaging operations (e.g. the ability to deliver messages to multiple contacts via a single API call.) Contact group can be represented as a fixed list of contacts or can be represented as a specific criteria (filter) and each time the group is referenced, SCG will compute the list of contacts that match the criteria to define the contacts within the contact group. Contact groups are owned by Clients and composed of Contacts.

Resource attributes:

id (string): Unique identifier of the contact group
external_id (string): Customer supplied id of the contact group
name (string): A name for the group
description (string): Group description

type (string): The group type-

- DYNAMIC- meaning the list of members associated with the group is calculated dynamically whenever the group is referenced by applying the CRITERIA to the customer contact list

- STATIC- meaning the list of members is determined at the time of contact group creation and hence static. Customers will be also able to add or remove contacts from a STATIC group by accessing the contacts list associated with the group

criteria (string): Filter definition for creation of the group. Users can use either criteria or members
status (string): Processing
```
Ready
```
member_count (number): Count of members in the group.
application_id (integer): ID of the application that has created the resource
created_date (date): The creation date of the object.
last_updated_date (date): The last modification date of the object.
version_number (integer): An ascending version number of the object. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking.

/contact_groups get post

get
Returns the list of matching Groups

Returns the list of matching Groups

Request
Response

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
name: (string)
Filter
type: (string)
Filter
status: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Group List",
  "type": "array",
  "items": {
    "title": "Contact Group",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "criteria": {
        "type": "string"
      },
      "status": {
        "type": "string"
      },
      "member_count": {
        "type": "number"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1017 - Invalid Json expression in Dynamic Group definition - The Dymanic Group deffinition was invalid
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Group Resource

Creates a new Group Resource

Request
Response

Body

Type: application/json

Form Parameters

external_id: (string)
name: (string)
description: (string)
type: (string)
criteria: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1017 - Invalid Json expression in Dynamic Group definition - The Dymanic Group deffinition was invalid
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contact_groups/{Group_ID} get post delete put

The Group resource associated with the provided ID

get
Returns the current version of the specified Group

Returns the current version of the specified Group

Request
Response

URI Parameters

Group_ID: required (string)
This is the unique identifier of the Group resource.

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
name: (string)
Filter
type: (string)
Filter
status: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Group",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "criteria": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "member_count": {
      "type": "number"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Updates the contact group resource - only attributes present in the post and that are not immutable will be updates

Updates the contact group resource - only attributes present in the post and that are not immutable will be updates

Request
Response

URI Parameters

Group_ID: required (string)
This is the unique identifier of the Group resource.

Body

Type: application/json

Form Parameters

external_id: (string)
name: (string)
description: (string)
type: (string)
criteria: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Group resource with the specified ID

Deletes the Group resource with the specified ID

Request
Response

URI Parameters

Group_ID: required (string)
This is the unique identifier of the Group resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

put
Replaces specified group ID

Replaces specified group ID

Request
Response

URI Parameters

Group_ID: required (string)
This is the unique identifier of the Group resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters

external_id: (string)
name: (string)
description: (string)
type: (string)
criteria: (string)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contact_groups/{Group_ID}/contacts get post

List of all Contacts associated with the provided Group ID

get
Returns the list of contacts associated with the contact group. The list will be computed on the fly by SCG for DYNAMIC groups.

Returns the list of contacts associated with the contact group. The list will be computed on the fly by SCG for DYNAMIC groups.

Request
Response

URI Parameters

Group_ID: required (string)
This is the unique identifier of the Group resource.

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
first_name: (string)
Filter
last_name: (string)
Filter
birth_date: (date)
Filter
first_acquisition_date: (date)
Filter
last_acquisition_date: (date)
Filter
primary_mdn: (string)
Filter
primary_addr_line1: (string)
Filter
primary_addr_line2: (string)
Filter
primary_addr_city: (string)
Filter
primary_addr_zip: (string)
Filter
primary_addr_state: (string)
Filter
primary_email_addr: (string)
Filter
primary_addr_country: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact List",
  "type": "array",
  "items": {
    "title": "Contact",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "external_id": {
        "type": "string"
      },
      "first_name": {
        "type": "string"
      },
      "last_name": {
        "type": "string"
      },
      "birth_date": {
        "type": "date"
      },
      "first_acquisition_date": {
        "type": "date"
      },
      "last_acquisition_date": {
        "type": "date"
      },
      "primary_mdn": {
        "type": "string"
      },
      "primary_addr_line1": {
        "type": "string"
      },
      "primary_addr_line2": {
        "type": "string"
      },
      "primary_addr_city": {
        "type": "string"
      },
      "primary_addr_zip": {
        "type": "string"
      },
      "primary_addr_state": {
        "type": "string"
      },
      "primary_email_addr": {
        "type": "string"
      },
      "primary_addr_country": {
        "type": "string"
      },
      "primary_social_handle": {
        "type": "string"
      },
      "address_list": {
        "type": "string"
      },
      "customer_account_list": {
        "type": "string"
      },
      "customer_device_list": {
        "type": "string"
      },
      "interest_list": {
        "type": "string"
      },
      "demographic_list": {
        "type": "string"
      },
      "extended_attributes": {
        "type": "string"
      },
      "fast_access": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      },
      "preferred_language": {
        "type": "string"
      },
      "voice_preference": {
        "type": "boolean"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
adds a contact to a static contact group

adds a contact to a static contact group

Request
Response

URI Parameters

Group_ID: required (string)
This is the unique identifier of the Group resource.

Body

Type: application/json

Form Parameters

external_id: (string)
first_name: (string)
last_name: (string)
birth_date: (date)
first_acquisition_date: (date)
last_acquisition_date: (date)
primary_mdn: (string)
primary_addr_line1: (string)
primary_addr_line2: (string)
primary_addr_city: (string)
primary_addr_zip: (string)
primary_addr_state: (string)
primary_email_addr: (string)
primary_addr_country: (string)
primary_social_handle: (string)
address_list: (string)
customer_account_list: (string)
customer_device_list: (string)
interest_list: (string)
demographic_list: (string)
extended_attributes: (string)
preferred_language: (string)
voice_preference: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contact_groups/{Group_ID}/contacts/{Contact_ID} get delete

A contact associated with an element in the contact group

get
Returns the contact id

Returns the contact id

Request
Response

URI Parameters

Group_ID: required (string)
This is the unique identifier of the Group resource.
Contact_ID: required (string)
This is the unique identifier of the Contact resource.

Query Parameters

id: (string)
Filter
external_id: (string)
Filter
first_name: (string)
Filter
last_name: (string)
Filter
birth_date: (date)
Filter
first_acquisition_date: (date)
Filter
last_acquisition_date: (date)
Filter
primary_mdn: (string)
Filter
primary_addr_line1: (string)
Filter
primary_addr_line2: (string)
Filter
primary_addr_city: (string)
Filter
primary_addr_zip: (string)
Filter
primary_addr_state: (string)
Filter
primary_email_addr: (string)
Filter
primary_addr_country: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "birth_date": {
      "type": "date"
    },
    "first_acquisition_date": {
      "type": "date"
    },
    "last_acquisition_date": {
      "type": "date"
    },
    "primary_mdn": {
      "type": "string"
    },
    "primary_addr_line1": {
      "type": "string"
    },
    "primary_addr_line2": {
      "type": "string"
    },
    "primary_addr_city": {
      "type": "string"
    },
    "primary_addr_zip": {
      "type": "string"
    },
    "primary_addr_state": {
      "type": "string"
    },
    "primary_email_addr": {
      "type": "string"
    },
    "primary_addr_country": {
      "type": "string"
    },
    "primary_social_handle": {
      "type": "string"
    },
    "address_list": {
      "type": "string"
    },
    "customer_account_list": {
      "type": "string"
    },
    "customer_device_list": {
      "type": "string"
    },
    "interest_list": {
      "type": "string"
    },
    "demographic_list": {
      "type": "string"
    },
    "extended_attributes": {
      "type": "string"
    },
    "fast_access": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    },
    "preferred_language": {
      "type": "string"
    },
    "voice_preference": {
      "type": "boolean"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
removes the contact from the contact group (applies only to STATIC lists)

removes the contact from the contact group (applies only to STATIC lists)

Request
Response

URI Parameters

Group_ID: required (string)
This is the unique identifier of the Group resource.
Contact_ID: required (string)
This is the unique identifier of the Contact resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Keywords

Keywords are defined by customer and represent special words that customers can send to a number beIntegering to a customer. Keywords are detected by SCG and added to the customer profile. Certain actions can be associated with a keyword received from a customer

Resource attributes:

id (string): unique keyword id
name (string): name of the keyword
description (string): description of the keyword
value (string): the keyword. For example 'SPORTS'. The keyword can be expressed in form of a regular expression. POSIX Extended syntax is supported.
case (string): SENSITIVE/INSENSITIVE specifies whether the keyword is case sensitive or not. default is not case sensitive.
sender_id (string): The sender id on which the keyword is valid. When this is empty, any sender id associated with the given customer will be sensitive to this keyword
valid_from (date): the date range for which the keyword is valid
valid_to (date): the date range for which the keyword is valid
associated_info (string): additional information, value is at customer discretion, this attribute is added to the keyword event whenever the keyword is detected
campaign_id (string): The campaign id

type (string): the type of the keyword-

- RESERVED- those are the platform specific keywords that can not be used by customer in any campaign. Those keywords will always exist, the company will never need to add them

- COMPANY- company specific keywords

actions (string): actions to be applied when the keyword has been received. Multiple actions can be specified. The various actions should be separated by a coma or space-

- OPTOUT -> mark the user as explicitly opted out (and forward message to Consent Manager)

- OPTIN > mark the user as explicitly opted in (and forward message to Consent Manager)

- STORE -> no action, just record in user profile

reply_template (string): if specified then SCG will send a predefined message back to the user. This attribute will contain the name of the message template to be used in the automatic reply
application_id (integer): ID of the application that has created the resource
created_date (date): The creation date of the object.
last_updated_date (date): The last modification date of the object.
version_number (integer): An ascending version number of the object. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking.

/messaging/keywords get post

get
Returns the list of all keywords that are public or beInteger to the customer

Returns the list of all keywords that are public or beInteger to the customer

Request
Response

Query Parameters

id: (string)
Filter
name: (string)
Filter
value: (string)
Filter
case: (string)
Filter
sender_id: (string)
Filter
valid_from: (date)
Filter
valid_to: (date)
Filter
campaign_id: (string)
Filter
type: (string)
Filter
actions: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Keywords List",
  "type": "array",
  "items": {
    "title": "Keywords",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "value": {
        "type": "string"
      },
      "case": {
        "type": "string"
      },
      "sender_id": {
        "type": "string"
      },
      "valid_from": {
        "type": "date"
      },
      "valid_to": {
        "type": "date"
      },
      "associated_info": {
        "type": "string"
      },
      "campaign_id": {
        "type": "string"
      },
      "type": {
        "type": "string"
      },
      "actions": {
        "type": "string"
      },
      "reply_template": {
        "type": "string"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new keyword

Creates a new keyword

Request
Response

Body

Type: application/json

Form Parameters

name: (string)
description: (string)
value: (string)
case: (string)
sender_id: (string)
valid_from: (date)
valid_to: (date)
associated_info: (string)
campaign_id: (string)
type: (string)
actions: (string)
reply_template: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/messaging/keywords/{Keyword_ID} get post delete put

The specific keyword

get
Returnes the specific keyword resource instance

Returnes the specific keyword resource instance

Request
Response

URI Parameters

Keyword_ID: required (string)
This is the unique identifier of the Keyword resource.

Query Parameters

id: (string)
Filter
name: (string)
Filter
value: (string)
Filter
case: (string)
Filter
sender_id: (string)
Filter
valid_from: (date)
Filter
valid_to: (date)
Filter
campaign_id: (string)
Filter
type: (string)
Filter
actions: (string)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Keywords",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "case": {
      "type": "string"
    },
    "sender_id": {
      "type": "string"
    },
    "valid_from": {
      "type": "date"
    },
    "valid_to": {
      "type": "date"
    },
    "associated_info": {
      "type": "string"
    },
    "campaign_id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "actions": {
      "type": "string"
    },
    "reply_template": {
      "type": "string"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
updates the keyword

updates the keyword

Request
Response

URI Parameters

Keyword_ID: required (string)
This is the unique identifier of the Keyword resource.

Body

Type: application/json

Form Parameters

name: (string)
description: (string)
value: (string)
case: (string)
sender_id: (string)
valid_from: (date)
valid_to: (date)
associated_info: (string)
campaign_id: (string)
type: (string)
actions: (string)
reply_template: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes specified keyword

Deletes specified keyword

Request
Response

URI Parameters

Keyword_ID: required (string)
This is the unique identifier of the Keyword resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

put
Replaces the keyword

Replaces the keyword

Request
Response

URI Parameters

Keyword_ID: required (string)
This is the unique identifier of the Keyword resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters

name: (string)
description: (string)
value: (string)
case: (string)
sender_id: (string)
valid_from: (date)
valid_to: (date)
associated_info: (string)
campaign_id: (string)
type: (string)
actions: (string)
reply_template: (string)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Contact Import Job

Contact Import job is created and provided with import CSV file attachment id, uploaded prior to starting the job. Once created, the job is added to queue and waiting execution. GET by job id to see current state.

Resource attributes:

id (string): unique job id
contact_group_id (string): Contact Group id - optional, add imported contacts to this group
import_attachment_id (string): Import file attachment id - should be in state UPLOADED (file uploaded)
failures_attachment_id (string): Failures file attachment id - optional, null when no errors produced during import job
state (string): CREATED, RUNNING, COMPLETED - job status
imported_count (integer): count of contacts imported successfully
failed_count (integer): count of contacts failed to import
started_date (date): Start time of job
completed_date (date): Time of job complete
application_id (integer): ID of the application that has created the resource
created_date (date): The creation date of the object.
last_updated_date (date): The last modification date of the object.
version_number (integer): An ascending version number of the object. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking.

/contactimport/{Job_ID} get delete

get
Returns the job details

Returns the job details

Request
Response

URI Parameters

Job_ID: required (string)
This is the unique identifier of the Job resource.

Query Parameters

id: (string)
Filter
state: (string)
Filter
completed_date: (date)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Import Job",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "contact_group_id": {
      "type": "string"
    },
    "import_attachment_id": {
      "type": "string"
    },
    "failures_attachment_id": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "imported_count": {
      "type": "integer"
    },
    "failed_count": {
      "type": "integer"
    },
    "started_date": {
      "type": "date"
    },
    "completed_date": {
      "type": "date"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Contact Import Job resource with the specified ID

Deletes the Contact Import Job resource with the specified ID

Request
Response

URI Parameters

Job_ID: required (string)
This is the unique identifier of the Job resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Contact Export Job

Contact Export job - asynchronic running job of exporting customer contacts to CSV file. Once created, the job is added to queue and waiting execution. GET by job id to see current state.

Resource attributes:

id (string): unique job id
contact_group_id (string): Contact Group id - optional, export contacts from given group only
export_attachment_id (string): Export file attachment id - should be in state UPLOADED (file uploaded)
state (string): CREATED, RUNNING, COMPLETED - job status
exported_count (integer): count of contacts exported
started_date (date): Start time of job
completed_date (date): Time of job complete
application_id (integer): ID of the application that has created the resource
created_date (date): The creation date of the object.
last_updated_date (date): The last modification date of the object.
version_number (integer): An ascending version number of the object. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking.

/contactexport get post

get
Returns the list of matching contact export jobs

Returns the list of matching contact export jobs

Request
Response

Query Parameters

id: (string)
Filter
state: (string)
Filter
started_date: (date)
Filter
completed_date: (date)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Export Job List",
  "type": "array",
  "items": {
    "title": "Contact Export Job",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "contact_group_id": {
        "type": "string"
      },
      "export_attachment_id": {
        "type": "string"
      },
      "state": {
        "type": "string"
      },
      "exported_count": {
        "type": "integer"
      },
      "started_date": {
        "type": "date"
      },
      "completed_date": {
        "type": "date"
      },
      "application_id": {
        "type": "integer"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

post
Creates a new Contact Export Job

Creates a new Contact Export Job

Request
Response

Body

Type: application/json

Form Parameters

contact_group_id: (string)
export_attachment_id: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/contactexport/{Job_ID} get delete

The Contact Export Job resource associated with the provided ID

get
Returns the job details

Returns the job details

Request
Response

URI Parameters

Job_ID: required (string)
This is the unique identifier of the Job resource.

Query Parameters

id: (string)
Filter
state: (string)
Filter
started_date: (date)
Filter
completed_date: (date)
Filter
application_id: (integer)
Filter
created_date: (date)
Filter
last_updated_date: (date)
Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Contact Export Job",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "contact_group_id": {
      "type": "string"
    },
    "export_attachment_id": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "exported_count": {
      "type": "integer"
    },
    "started_date": {
      "type": "date"
    },
    "completed_date": {
      "type": "date"
    },
    "application_id": {
      "type": "integer"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

delete
Deletes the Contact Export Job resource with the specified ID

Deletes the Contact Export Job resource with the specified ID

Request
Response

URI Parameters

Job_ID: required (string)
This is the unique identifier of the Job resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

400 - Bad Request - Error Message provides information about what's wrong with the request
1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
1011 - Error message contains details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.