Event Subscription Service API documentation
version 1.0.0
https://api.syniverse.com/ess/v1
topic-subscriptions
get
Get all subscription details for a given company (irrespective of the topic)
get /topic-subscriptions
Get all subscription details for a given company (irrespective of the topic)
Headers
- Authorization: required (string)
- user-token: required (string)
Query Parameters
- limit: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"paged-result": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
},
"topic-subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"del-cfg-id": {
"type": "string"
},
"del-cfg-nm": {
"type": "string"
},
"topic-nm": {
"type": "string"
},
"evt-tp": {
"type": "string"
},
"match-crt": {
"type": "string"
},
"start-date": {
"type": "string"
}
}
}
}
},
"example": {
"paged-result": {
"offset": 0,
"limit": 1000
},
"topic-subscriptions": [
{
"id": "16301830",
"del-cfg-id": "1266",
"del-cfg-nm": "a-mock-del-cfg",
"topic-nm": "SCG-Message",
"evt-tp": "message_state_change",
"match-crt": "",
"start-date": "1970-01-01T00:00:00Z"
},
{
"id": "16301850",
"del-cfg-id": "1647",
"del-cfg-nm": "Truedisconnect1",
"topic-nm": "MSS-Messages",
"match-crt": "",
"start-date": "2017-10-18T16:22:37Z"
},
{
"id": "16301810",
"del-cfg-id": "1266",
"del-cfg-nm": "a-mock-del-cfg",
"topic-nm": "NIS-Events",
"evt-tp": "porting_event",
"match-crt": "number = '+12345678901'",
"start-date": "1970-01-01T00:00:00Z"
}
]
}
}get
Get subscriptions for given phone number for a customer
get /topic-subscriptions/mdn
Get subscriptions for given phone number for a customer
Headers
- Authorization: required (string)
- user-token: required (string)
Query Parameters
- topicId: required (string)
values for topicId is "NIS-Events"
- matchingCriteria: required (string)
matchingCriteria value should be url encoded.
ex:number = '+12345678901'
corresponding encode value is "number%20%3D%20%27%2B12345678901%27"
- limit: required (string)
limit number of results in response
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"paged-result": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
},
"mdn": {
"type": "string"
},
"topic-name": {
"type": "string"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"delivery-cfg-id": {
"type": "string"
},
"delivery-cfg-nm": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"example": {
"paged-result": {
"offset": 0,
"limit": 50
},
"mdn": "number = '+12345678901'",
"topic-name": "NIS-Events",
"subscriptions": [
{
"delivery-cfg-id": "1266",
"delivery-cfg-nm": "a-mock-del-cfg",
"events": [
"porting_event"
]
}
]
}
}get
Get Count of total unique number of MDN's subscribed for a customer.
get /topic-subscriptions/uniqueMdnCount
Get Count of total unique number of MDN's subscribed for a customer.
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"topic-name": {
"type": "string"
},
"activeCount": {
"type": "integer"
}
},
"example": {
"topic-name": "NIS-Events",
"activeCount": 1
}
}handled-event-deliveries
post
post /handled-event-deliveries
Headers
- Authorization: required (string)
- user-token: required (string)
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"event-id": {
"type": "string"
},
"topic": {
"type": "string"
},
"event-type": {
"type": "string"
},
"del-cfg-nm": {
"type": "string"
},
"timestamp": {
"type": "string"
}
},
"example": {
"event-id": "event-3",
"topic": "topic-C",
"event-type": "some-type-3",
"del-cfg-nm": "Delivery Configuration 1",
"timestamp": "[1970-01-01T00:00:00-]"
}
}HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"number-of-updated-event-deliveries": {
"type": "integer"
}
},
"example": {
"number-of-updated-event-deliveries": 1
}
}delivery-configurations
get
post
get /delivery-configurations
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"paged-result": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
},
"delivery-configurations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"del-cfg-nm": {
"type": "string"
},
"del-prtcl-cd": {
"type": "string"
},
"addr": {
"type": "string"
},
"del-fmt-cd": {
"type": "string"
},
"is-active": {
"type": "boolean"
},
"id": {
"type": "string"
},
"throttling": {
"type": "integer"
}
}
}
}
},
"example": {
"paged-result": {
"offset": 0,
"limit": 1000
},
"delivery-configurations": [
{
"del-cfg-nm": "performance-test-delivery-configuration-Rph5yh7GF3",
"del-prtcl-cd": "REST",
"addr": "http://oasidfjoasidjfoiasjdfoiasjd.syniverse.com/aspdijpasiodj",
"del-fmt-cd": "JSON",
"is-active": true,
"id": "1234"
},
{
"del-cfg-nm": "a-mock-del-cfg",
"del-prtcl-cd": "REST",
"addr": "http://da3d-gen-sao-odb002.dalab.syniverse.com:25002/saop-mock/v1/hello/testpost-ntv",
"del-fmt-cd": "JSON",
"is-active": true,
"id": "1266"
},
{
"del-cfg-nm": "a-new-delivery-configuration-1",
"del-prtcl-cd": "REST",
"addr": "http://putsreq.com/uS0LbraAGPLEGKtNW60V",
"del-fmt-cd": "JSON",
"is-active": true,
"id": "1327"
},
{
"del-cfg-nm": "Truedisconnect1",
"del-prtcl-cd": "REST",
"addr": "https://putsreq.com/9vGDLs9JWx9USiJXgZtL",
"del-fmt-cd": "JSON",
"is-active": true,
"id": "1647"
},
{
"del-cfg-nm": "GGG",
"del-prtcl-cd": "REST",
"addr": "http://www.wwww.wwwww",
"del-fmt-cd": "JSON",
"is-active": true,
"id": "1651"
},
{
"del-cfg-nm": "TestDelivery",
"del-prtcl-cd": "REST",
"addr": "https://www.google.com/delivery",
"del-fmt-cd": "JSON",
"is-active": true,
"throttling": 20,
"id": "1652"
},
{
"del-cfg-nm": "Schedular",
"del-prtcl-cd": "REST",
"addr": "http://da3d-gen-bit-wls005.dalab.syniverse.com:45002/ess-event-buffer/v1/aggregate/1653",
"del-fmt-cd": "JSON",
"is-active": true,
"cron-expression": "0 15 * * * *",
"latest-event-only": true,
"id": "1653"
},
{
"del-cfg-nm": "hhh",
"del-prtcl-cd": "REST",
"addr": "http://wwww.giiig",
"del-fmt-cd": "JSON",
"is-active": true,
"throttling": 32,
"id": "1654"
}
]
}
}post /delivery-configurations
Headers
- Authorization: required (string)
- user-token: required (string)
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"del-cfg-nm": {
"type": "string"
},
"del-prtcl-cd": {
"type": "string"
},
"addr": {
"type": "string"
},
"del-fmt-cd": {
"type": "string"
},
"is-active": {
"type": "boolean"
},
"throttling": {
"type": "integer"
},
"cron-expression": {
"type": "string",
"description": "if cron-expression element is true example json:\n{\"del-cfg-nm\":\"Schedular\",\"del-fmt-cd\":\"JSON\",\"is-active\":true,\"cron-expression\":\"0 15 * * * *\",\"latest-event-only\":true}\nif cron-expression element is false example json:\n{\"del-cfg-nm\":\"hhh\",\"del-prtcl-cd\":\"REST\",\"addr\":\"http://wwww.giiig\",\"del-fmt-cd\":\"JSON\",\"throttling\":32,\"is-active\":true}"
},
"latest-event-only": {
"type": "boolean"
}
},
"example": {
"del-cfg-nm": "dd",
"del-prtcl-cd": "dd",
"addr": "dd",
"del-fmt-cd": "dd",
"is-active": "dd",
"throttling": "dd",
"cron-expression": "dd",
"latest-event-only": "dd"
}
}get
Get a specific delivery configuration
put
update specific delivery configuration
get /delivery-configurations/{del-config-id}
Get a specific delivery configuration
URI Parameters
- del-config-id: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"del-cfg-nm": {
"type": "string"
},
"del-prtcl-cd": {
"type": "string"
},
"addr": {
"type": "string"
},
"del-fmt-cd": {
"type": "string"
},
"is-active": {
"type": "boolean"
},
"throttling": {
"type": "integer"
},
"id": {
"type": "string"
}
},
"example": {
"del-cfg-nm": "hhh",
"del-prtcl-cd": "REST",
"addr": "http://wwww.giiig",
"del-fmt-cd": "JSON",
"is-active": true,
"throttling": 32,
"id": "1654"
}
}put /delivery-configurations/{del-config-id}
update specific delivery configuration
URI Parameters
- del-config-id: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"del-cfg-nm": {
"type": "string"
},
"del-prtcl-cd": {
"type": "string"
},
"addr": {
"type": "string"
},
"del-fmt-cd": {
"type": "string"
},
"throttling": {
"type": "integer"
},
"is-active": {
"type": "boolean"
}
},
"example": {
"del-cfg-nm": "hhh",
"del-prtcl-cd": "REST",
"addr": "http://wwww.giiig",
"del-fmt-cd": "JSON",
"throttling": 322,
"is-active": true
}
}get
Get the associated authentication details for a given delivery configuration
put
Modify given delivery configuration with authentication
get /delivery-configurations/{del-config-id}/authentication
Get the associated authentication details for a given delivery configuration
URI Parameters
- del-config-id: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"settings": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
},
"example": {
"type": "BASIC",
"settings": {
"username": "Admin",
"password": "adnin"
}
}
}put /delivery-configurations/{del-config-id}/authentication
Modify given delivery configuration with authentication
URI Parameters
- del-config-id: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"settings": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
},
"required": [
"type",
"settings"
],
"example": {
"type": "BASIC",
"settings": {
"username": "Admin",
"password": "adnin"
}
}
}topics
get
Get details for all topics for a given company
get /topics
Get details for all topics for a given company
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"paged-result": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"topic-nm": {
"type": "string"
},
"svc-nm": {
"type": "string"
},
"evt-tp-list": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"example": {
"paged-result": {
"offset": 0,
"limit": 10000000
},
"topics": [
{
"topic-nm": "ABA-Messages",
"svc-nm": "ABA",
"evt-tp-list": [
"aba_job_completed",
"aba_job_queued",
"aba_job_resumed",
"aba_job_started",
"aba_job_suspended"
]
},
{
"topic-nm": "DevTest-Events",
"evt-tp-list": [
"__GENERIC__"
]
},
{
"topic-nm": "MSS-Messages",
"svc-nm": "MSS",
"evt-tp-list": [
"event_file_complete",
"event_file_delete",
"event_file_download"
]
},
{
"topic-nm": "NIS-Events",
"svc-nm": "NIS",
"evt-tp-list": [
"deactivation_event",
"porting_event",
"truedisconnect_event"
]
},
{
"topic-nm": "SCG-Communication-Assistant",
"svc-nm": "SCG / IMN",
"evt-tp-list": [
"communication_application_processor",
"communication_application_session_custom_event",
"communication_application_session_state_change"
]
},
{
"topic-nm": "SCG-Contact",
"svc-nm": "SCG / IMN",
"evt-tp-list": [
"application_token_state_change"
]
},
{
"topic-nm": "SCG-Keyword",
"svc-nm": "SCG / IMN",
"evt-tp-list": [
"keyword_message_received"
]
},
{
"topic-nm": "SCG-Message",
"svc-nm": "SCG / IMN",
"evt-tp-list": [
"message_request_state_change",
"message_state_change",
"mo_message_received"
]
},
{
"topic-nm": "SCG-Sender-ID",
"svc-nm": "SCG / IMN",
"evt-tp-list": [
"sender_id_recipient_consent_change",
"sender_id_state_change"
]
},
{
"topic-nm": "SCG-Voice-Call",
"svc-nm": "SCG / IMN",
"evt-tp-list": [
"bridge_playback_state_change",
"bridge_tts_state_change",
"call_incoming_received",
"call_playback_state_change",
"call_state_change",
"call_tts_state_change",
"collector_state_change",
"conference_member_play_state_change",
"conference_member_state_change",
"conference_member_tts_state_change",
"conference_playback_state_change",
"conference_speak_state_change",
"conference_state_change",
"dtmf",
"recording_state_change"
]
}
]
}
}post
Create a new topic subscription for a specific topic
post /topics/{ID}/subscriptions
Create a new topic subscription for a specific topic
URI Parameters
- ID: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"del-cfg-id": {
"type": "string"
},
"evt-tp": {
"type": "string"
},
"match-crt": {
"type": "string"
},
"start-date": {
"type": "string"
},
"end-date": {
"type": "null"
}
},
"example": {
"del-cfg-id": "262",
"evt-tp": "communication_application_session_state_change",
"match-crt": "",
"start-date": "2017-10-27T17:29:42Z",
"end-date": null
}
}get
Get details for a specific subscription associated with a specific topic
put
Update an existing delivery configuration associated with a specifc topic
get /topics/{ID}/subscriptions/{SUBSCRIPTION_NUMBER}
Get details for a specific subscription associated with a specific topic
URI Parameters
- ID: required (string)
- SUBSCRIPTION_NUMBER: required (string)
subscriptionid
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"del-cfg-id": {
"type": "integer"
},
"evt-tp": {
"type": "string"
},
"match-crt": {
"type": "string"
},
"start-date": {
"type": "string"
},
"id": {
"type": "string"
},
"topic-nm": {
"type": "string"
}
},
"example": {
"del-cfg-id": 262,
"evt-tp": "mo_message_received",
"match-crt": "",
"start-date": "2016-09-27T13:08:57Z",
"id": "142",
"topic-nm": "SCG-Message"
}
}put /topics/{ID}/subscriptions/{SUBSCRIPTION_NUMBER}
Update an existing delivery configuration associated with a specifc topic
URI Parameters
- ID: required (string)
- SUBSCRIPTION_NUMBER: required (string)
subscriptionid
Headers
- Authorization: required (string)
- user-token: required (string)
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"match-crt": {
"type": "string"
},
"start-date": {
"type": "string"
},
"end-date": {
"type": "null"
}
},
"example": {
"match-crt": "company-id = 123",
"start-date": "2016-09-27T13:08:57Z",
"end-date": null
}
}get
Get the event types and associated fields that are currently supported for given topoic
get /topics/{ID}/event-types
Get the event types and associated fields that are currently supported for given topoic
URI Parameters
- ID: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"event-types": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"validation-type": {
"type": "string"
},
"fields": {
"type": "object",
"properties": {
"number": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"previous_carrier_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"previous_carrier_name": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"tracking_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"deactivation_date": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"carrier_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"porting_date": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"carrier_name": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"example": {
"event-types": [
{
"id": "deactivation_event",
"validation-type": "strict",
"fields": {
"number": {
"type": "Text",
"mandatory": true
},
"previous_carrier_id": {
"type": "Text",
"mandatory": false
},
"previous_carrier_name": {
"type": "Text",
"mandatory": false
},
"tracking_id": {
"type": "Text",
"mandatory": false
},
"deactivation_date": {
"type": "Date",
"mandatory": true
}
}
},
{
"id": "porting_event",
"validation-type": "strict",
"fields": {
"carrier_id": {
"type": "Text",
"mandatory": false
},
"number": {
"type": "Text",
"mandatory": true
},
"previous_carrier_id": {
"type": "Text",
"mandatory": false
},
"porting_date": {
"type": "Date",
"mandatory": true
},
"carrier_name": {
"type": "Text",
"mandatory": false
},
"previous_carrier_name": {
"type": "Text",
"mandatory": false
},
"tracking_id": {
"type": "Text",
"mandatory": false
}
}
},
{
"id": "truedisconnect_event",
"validation-type": "strict",
"fields": {
"number": {
"type": "Text",
"mandatory": true
},
"previous_carrier_id": {
"type": "Text",
"mandatory": false
},
"previous_carrier_name": {
"type": "Text",
"mandatory": false
},
"tracking_id": {
"type": "Text",
"mandatory": false
},
"deactivation_date": {
"type": "Date",
"mandatory": true
}
}
}
]
}
}get
Get the subscriptions for a given Topic in the form of file to download.The prerequisite for using this API is to create a delivery configuration for file-complete event under MSS-Messages topic.Once file creation completed,notification will be sent with file location to download.
get /topics/{ID}/dump-subscriptions
Get the subscriptions for a given Topic in the form of file to download.The prerequisite for using this API is to create a delivery configuration for file-complete event under MSS-Messages topic.Once file creation completed,notification will be sent with file location to download.
URI Parameters
- ID: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
Query Parameters
- compression: required (boolean)
- compressionType: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"referenceId": {
"type": "string",
"description": "reference id for future communication"
}
},
"example": {
"referenceId": "2569"
}
}dictionaries
get
DICT_CODE values are delivery-formats - Get supported delivery formats (JSON,XML) delivery-protocols - Get supported protocols (REST) authentication-types - Get supported authentications (BASIC,OAUTH,NONE)
get /dictionaries/{DICT_CODE}
DICT_CODE values are delivery-formats - Get supported delivery formats (JSON,XML) delivery-protocols - Get supported protocols (REST) authentication-types - Get supported authentications (BASIC,OAUTH,NONE)
URI Parameters
- DICT_CODE: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"authentication-types": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
},
"example": {
"authentication-types": [
{
"code": "OAUTH",
"description": "OAuth 2.0"
},
{
"code": "NONE",
"description": "No Authentication"
},
{
"code": "BASIC",
"description": "Basic Authentication - ID / PW"
}
]
}
}event-deliveries
get
get /event-deliveries
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"paged-result": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
},
"next-page-uri": {
"type": "string"
},
"event-deliveries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"event-id": {
"type": "string"
},
"topic": {
"type": "string"
},
"event-type": {
"type": "string"
},
"delivery-point": {
"type": "string"
},
"del-cfg-id": {
"type": "integer"
},
"del-cfg-nm": {
"type": "string"
},
"delivery-status": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"event-body": {
"type": "string"
}
}
}
}
},
"example": {
"paged-result": {
"offset": 0,
"limit": 50
},
"next-page-uri": "/ess/v1/event-deliveries?offset=50&limit=50",
"event-deliveries": [
{
"event-id": "ADEIboH1Q7m-OYRV2m268A",
"topic": "NIS-Events",
"event-type": "porting_event",
"delivery-point": "http://da3d-gen-sao-odb002.dalab.syniverse.com:25002/saop-mock/v1/hello/testpost-ntv",
"del-cfg-id": 1266,
"del-cfg-nm": "a-mock-del-cfg",
"delivery-status": "SUCCESS",
"timestamp": "2017-06-30T12:59:30Z",
"event-body": "{\n \"carrier_id\": \"15799\",\n \"number\": \"+12345678901\",\n \"previous_carrier_id\": \"\",\n \"porting_date\": \"2011-05-27T00:00:00Z\",\n \"carrier_name\": \"PAETEC COMMUNICATIONS INC.\",\n \"previous_carrier_name\": \"\",\n \"tracking_id\": \"1092585662\"\n}"
},
{
"event-id": "_FTiBOP9SOKdEvpDMoqj9g",
"topic": "NIS-Events",
"event-type": "porting_event",
"delivery-point": "http://da3d-gen-sao-odb002.dalab.syniverse.com:25002/saop-mock/v1/hello/testpost-ntv",
"del-cfg-id": 1266,
"del-cfg-nm": "a-mock-del-cfg",
"delivery-status": "SUCCESS",
"timestamp": "2017-06-30T12:59:32Z",
"event-body": "{\n \"carrier_id\": \"15799\",\n \"number\": \"+12345678901\",\n \"previous_carrier_id\": \"\",\n \"porting_date\": \"2011-05-27T00:00:00Z\",\n \"carrier_name\": \"PAETEC COMMUNICATIONS INC.\",\n \"previous_carrier_name\": \"\",\n \"tracking_id\": \"1092585662\"\n}"
}
]
}
}get
Get the event delivery summary information containing number of events in each delivery status aggregated by delivery configuration, topic and event type
get /event-deliveries/summary
Get the event delivery summary information containing number of events in each delivery status aggregated by delivery configuration, topic and event type
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"delivery-configurations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"del-cfg-nm": {
"type": "string"
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"topic-nm": {
"type": "string"
},
"event-types": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pending": {
"type": "integer"
},
"retry": {
"type": "integer"
},
"failed": {
"type": "integer"
}
}
}
},
"pending": {
"type": "integer"
},
"retry": {
"type": "integer"
},
"failed": {
"type": "integer"
}
}
}
},
"pending": {
"type": "integer"
},
"retry": {
"type": "integer"
},
"failed": {
"type": "integer"
}
}
}
}
},
"example": {
"delivery-configurations": [
{
"del-cfg-nm": "release6 https test",
"topics": [
{
"topic-nm": "SCG-Message",
"event-types": [
{
"id": "mo_message_received",
"pending": 0,
"retry": 0,
"failed": 0
}
],
"pending": 0,
"retry": 0,
"failed": 0
}
],
"pending": 0,
"retry": 0,
"failed": 0
},
{
"del-cfg-nm": "ESS Buffer",
"topics": [
{
"topic-nm": "SCG-Message",
"event-types": [
{
"id": "mo_message_received",
"pending": 0,
"retry": 0,
"failed": 8
}
],
"pending": 0,
"retry": 0,
"failed": 8
}
],
"pending": 0,
"retry": 0,
"failed": 8
}
]
}
}get
Get the information about all possible delivery attemps for a given event id and delivery configuration combination
get /event-deliveries/{EVT_ID}:{DEL_CFG_ID}/tracking
Get the information about all possible delivery attemps for a given event id and delivery configuration combination
URI Parameters
- EVT_ID: required (string)
- DEL_CFG_ID: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"event-id": {
"type": "string"
},
"delivery-attempts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attempt-number": {
"type": "integer"
},
"status": {
"type": "string"
},
"response-status": {
"type": "integer"
},
"response-details": {
"type": "string"
},
"attempt-timestamp": {
"type": "string"
}
}
}
}
},
"example": {
"event-id": "hc4lnloTSK2aSvrLKiDpSA",
"delivery-attempts": [
{
"attempt-number": 1,
"status": "SUCCESS",
"response-status": 200,
"response-details": "Hello World",
"attempt-timestamp": "2017-10-28T17:14:54Z"
}
]
}
}event-types
get
Get the event types and associated fields tht are currently supported
get /event-types
Get the event types and associated fields tht are currently supported
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"paged-result": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
},
"event-types": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"validation-type": {
"type": "string"
},
"fields": {
"type": "object",
"properties": {
"output_file_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"company-id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"file_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"job_name": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"job_exec_complete_timestamp": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"error_file_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"error_details_file_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"file_name": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"job_exec_status": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"schedule_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"execution_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"member_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"conference_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"conference_external_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"state": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"call_external_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"application_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"member_external_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"call_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"number": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"previous_carrier_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"previous_carrier_name": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"tracking_id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"deactivation_date": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
}
}
}
}
}
}
},
"example": {
"paged-result": {
"offset": 0,
"limit": 50
},
"event-types": [
{
"id": "aba_job_completed",
"validation-type": "strict",
"fields": {
"output_file_uri": {
"type": "Text",
"mandatory": false
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"job_name": {
"type": "Text",
"mandatory": true
},
"job_exec_complete_timestamp": {
"type": "Date",
"mandatory": true
},
"error_file_uri": {
"type": "Text",
"mandatory": false
},
"error_details_file_uri": {
"type": "Text",
"mandatory": false
},
"file_name": {
"type": "Text",
"mandatory": true
},
"job_exec_status": {
"type": "Text",
"mandatory": true
},
"schedule_uri": {
"type": "Text",
"mandatory": true
},
"execution_uri": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "aba_job_queued",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"job_queued_timestamp": {
"type": "Date",
"mandatory": true
},
"job_name": {
"type": "Text",
"mandatory": true
},
"file_name": {
"type": "Text",
"mandatory": true
},
"schedule_uri": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "aba_job_resumed",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"job_name": {
"type": "Text",
"mandatory": true
},
"file_name": {
"type": "Text",
"mandatory": true
},
"resume_reason_cd": {
"type": "Text",
"mandatory": true
},
"job_exec_resume_timestamp": {
"type": "Date",
"mandatory": true
},
"schedule_uri": {
"type": "Text",
"mandatory": true
},
"execution_uri": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "aba_job_started",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"job_name": {
"type": "Text",
"mandatory": true
},
"file_name": {
"type": "Text",
"mandatory": true
},
"job_start_exec_timestamp": {
"type": "Date",
"mandatory": true
},
"schedule_uri": {
"type": "Text",
"mandatory": true
},
"execution_uri": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "aba_job_suspended",
"validation-type": "strict",
"fields": {
"suspend_reason_cd": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"job_name": {
"type": "Text",
"mandatory": true
},
"file_name": {
"type": "Text",
"mandatory": true
},
"job_exec_suspend_timestamp": {
"type": "Date",
"mandatory": true
},
"schedule_uri": {
"type": "Text",
"mandatory": true
},
"execution_uri": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "application_token_state_change",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"new_state": {
"type": "Text",
"mandatory": false
},
"sender_id_address": {
"type": "Text",
"mandatory": true
},
"contact_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
}
}
},
{
"id": "bridge_playback_state_change",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"bridge_id": {
"type": "Text",
"mandatory": true
},
"state": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"bridge_external_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "bridge_tts_state_change",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"bridge_id": {
"type": "Text",
"mandatory": true
},
"state": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"bridge_external_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "call_incoming_received",
"validation-type": "strict",
"fields": {
"reason_code": {
"type": "Text",
"mandatory": false
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"to_address": {
"type": "Text",
"mandatory": true
},
"reason_description": {
"type": "Text",
"mandatory": false
},
"from_address": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "call_playback_state_change",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"state": {
"type": "Text",
"mandatory": true
},
"call_external_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "call_state_change",
"validation-type": "strict",
"fields": {
"reason_code": {
"type": "Text",
"mandatory": true
},
"previous_state": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"external_call_id": {
"type": "Text",
"mandatory": true
},
"call_price": {
"type": "Decimal",
"mandatory": false
},
"new_state": {
"type": "Text",
"mandatory": true
},
"to_address": {
"type": "Text",
"mandatory": true
},
"reason_description": {
"type": "Text",
"mandatory": true
},
"from_address": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"call_duration": {
"type": "Integer",
"mandatory": true
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "call_tts_state_change",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"state": {
"type": "Text",
"mandatory": true
},
"call_external_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "collector_state_change",
"validation-type": "strict",
"fields": {
"reason": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"collect_id": {
"type": "Text",
"mandatory": true
},
"external_collect_id": {
"type": "Text",
"mandatory": true
},
"digits": {
"type": "Text",
"mandatory": true
},
"call_external_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "communication_application_processor",
"validation-type": "strict",
"fields": {
"communication_application_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"session_id": {
"type": "Text",
"mandatory": false
},
"processor_id": {
"type": "Text",
"mandatory": true
},
"user_data": {
"type": "Text",
"mandatory": false
},
"application_id": {
"type": "Integer",
"mandatory": false
}
}
},
{
"id": "communication_application_session_custom_event",
"validation-type": "strict",
"fields": {
"communication_application_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"custom_data": {
"type": "Text",
"mandatory": false
}
}
},
{
"id": "communication_application_session_state_change",
"validation-type": "strict",
"fields": {
"communication_application_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"sender_id_id": {
"type": "Text",
"mandatory": false
},
"old_state": {
"type": "Text",
"mandatory": true
},
"new_state": {
"type": "Text",
"mandatory": true
},
"result_code": {
"type": "Text",
"mandatory": false
},
"to_address": {
"type": "Text",
"mandatory": false
},
"ivr_timestamp": {
"type": "Date",
"mandatory": false
},
"from_address": {
"type": "Text",
"mandatory": false
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"result_details": {
"type": "Text",
"mandatory": false
}
}
},
{
"id": "conference_member_play_state_change",
"validation-type": "strict",
"fields": {
"member_id": {
"type": "Text",
"mandatory": true
},
"conference_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"conference_external_id": {
"type": "Text",
"mandatory": true
},
"state": {
"type": "Text",
"mandatory": true
},
"call_external_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"member_external_id": {
"type": "Text",
"mandatory": true
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "conference_member_state_change",
"validation-type": "strict",
"fields": {
"member_id": {
"type": "Text",
"mandatory": true
},
"conference_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"active_members": {
"type": "Integer",
"mandatory": true
},
"conference_external_id": {
"type": "Text",
"mandatory": true
},
"mute": {
"type": "Boolean",
"mandatory": false
},
"state": {
"type": "Text",
"mandatory": true
},
"call_external_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"member_external_id": {
"type": "Text",
"mandatory": true
},
"hold": {
"type": "Boolean",
"mandatory": false
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "conference_member_tts_state_change",
"validation-type": "strict",
"fields": {
"member_id": {
"type": "Text",
"mandatory": true
},
"conference_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"conference_external_id": {
"type": "Text",
"mandatory": true
},
"state": {
"type": "Text",
"mandatory": true
},
"call_external_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"member_external_id": {
"type": "Text",
"mandatory": true
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "conference_playback_state_change",
"validation-type": "strict",
"fields": {
"conference_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"conference_external_id": {
"type": "Text",
"mandatory": true
},
"state": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
}
}
},
{
"id": "conference_speak_state_change",
"validation-type": "strict",
"fields": {
"conference_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"conference_external_id": {
"type": "Text",
"mandatory": true
},
"state": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
}
}
},
{
"id": "conference_state_change",
"validation-type": "strict",
"fields": {
"conference_id": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"conference_external_id": {
"type": "Text",
"mandatory": true
},
"mute": {
"type": "Boolean",
"mandatory": false
},
"state": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"hold": {
"type": "Boolean",
"mandatory": false
}
}
},
{
"id": "deactivation_event",
"validation-type": "strict",
"fields": {
"number": {
"type": "Text",
"mandatory": true
},
"previous_carrier_id": {
"type": "Text",
"mandatory": false
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"previous_carrier_name": {
"type": "Text",
"mandatory": false
},
"tracking_id": {
"type": "Text",
"mandatory": false
},
"deactivation_date": {
"type": "Date",
"mandatory": true
}
}
},
{
"id": "dtmf",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"call_external_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"call_id": {
"type": "Text",
"mandatory": true
},
"digit": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "event_file_complete",
"validation-type": "strict",
"fields": {
"creation_time": {
"type": "Date",
"mandatory": true
},
"file_retention_time": {
"type": "Integer",
"mandatory": true
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"file_status": {
"type": "Text",
"mandatory": true
},
"file_name": {
"type": "Text",
"mandatory": false
},
"expire_time": {
"type": "Date",
"mandatory": true
},
"file_size": {
"type": "Integer",
"mandatory": true
},
"file_folder": {
"type": "Text",
"mandatory": false
},
"app_name": {
"type": "Text",
"mandatory": false
},
"modified_time": {
"type": "Date",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_id": {
"type": "Text",
"mandatory": true
},
"file_tags": {
"type": "Text",
"mandatory": false
}
}
},
{
"id": "event_file_delete",
"validation-type": "strict",
"fields": {
"modified_time": {
"type": "Date",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"file_status": {
"type": "Text",
"mandatory": true
},
"file_id": {
"type": "Text",
"mandatory": true
},
"file_size": {
"type": "Integer",
"mandatory": true
}
}
},
{
"id": "event_file_download",
"validation-type": "strict",
"fields": {
"app_name": {
"type": "Text",
"mandatory": false
},
"modified_time": {
"type": "Date",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"file_status": {
"type": "Text",
"mandatory": true
},
"file_name": {
"type": "Text",
"mandatory": false
},
"file_id": {
"type": "Text",
"mandatory": true
},
"file_tags": {
"type": "Text",
"mandatory": false
},
"expire_time": {
"type": "Date",
"mandatory": true
},
"file_size": {
"type": "Integer",
"mandatory": true
}
}
},
{
"id": "health-check",
"validation-type": "allow-additional-fields",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
}
}
},
{
"id": "keyword_message_received",
"validation-type": "strict",
"fields": {
"associated_info": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"sender_id_id": {
"type": "Text",
"mandatory": true
},
"keyword_id": {
"type": "Text",
"mandatory": true
},
"keyword_campaign_id": {
"type": "Text",
"mandatory": true
},
"keyword_value": {
"type": "Text",
"mandatory": true
},
"recipient_address": {
"type": "Text",
"mandatory": true
},
"keyword_action": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"reply_sent": {
"type": "Boolean",
"mandatory": true
}
}
},
{
"id": "message_request_state_change",
"validation-type": "strict",
"fields": {
"reason_code": {
"type": "Text",
"mandatory": true
},
"mo_price": {
"type": "Decimal",
"mandatory": false
},
"previous_state": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"external_message_request_id": {
"type": "Text",
"mandatory": false
},
"message_request_id": {
"type": "Text",
"mandatory": true
},
"new_state": {
"type": "Text",
"mandatory": true
},
"external_id": {
"type": "Text",
"mandatory": false
},
"reason_description": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"mt_price": {
"type": "Decimal",
"mandatory": false
}
}
},
{
"id": "message_state_change",
"validation-type": "strict",
"fields": {
"mo_price": {
"type": "Decimal",
"mandatory": false
},
"previous_state": {
"type": "Text",
"mandatory": true
},
"message_request_id": {
"type": "Text",
"mandatory": false
},
"message_id": {
"type": "Text",
"mandatory": true
},
"external_id": {
"type": "Text",
"mandatory": false
},
"to_address": {
"type": "Text",
"mandatory": false
},
"reason_description": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"reason_code": {
"type": "Text",
"mandatory": true
},
"sender_id_alias": {
"type": "Text",
"mandatory": false
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"sender_id_id": {
"type": "Text",
"mandatory": false
},
"external_message_request_id": {
"type": "Text",
"mandatory": false
},
"new_state": {
"type": "Text",
"mandatory": true
},
"fragments_count": {
"type": "Integer",
"mandatory": false
},
"from_address": {
"type": "Text",
"mandatory": false
},
"mt_price": {
"type": "Decimal",
"mandatory": false
}
}
},
{
"id": "mo_message_received",
"validation-type": "strict",
"fields": {
"mo_price": {
"type": "Decimal",
"mandatory": false
},
"message_request_id": {
"type": "Text",
"mandatory": false
},
"message_id": {
"type": "Text",
"mandatory": true
},
"has_attachment": {
"type": "Boolean",
"mandatory": false
},
"external_id": {
"type": "Text",
"mandatory": false
},
"to_address": {
"type": "Text",
"mandatory": false
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"sender_id_alias": {
"type": "Text",
"mandatory": false
},
"message_body_truncated": {
"type": "Boolean",
"mandatory": false
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"sender_id_id": {
"type": "Text",
"mandatory": false
},
"message_body": {
"type": "Text",
"mandatory": true
},
"fragments_count": {
"type": "Integer",
"mandatory": false
},
"from_address": {
"type": "Text",
"mandatory": false
},
"mt_price": {
"type": "Decimal",
"mandatory": false
},
"message_body_content_type": {
"type": "Text",
"mandatory": false
}
}
},
{
"id": "porting_event",
"validation-type": "strict",
"fields": {
"carrier_id": {
"type": "Text",
"mandatory": false
},
"number": {
"type": "Text",
"mandatory": true
},
"previous_carrier_id": {
"type": "Text",
"mandatory": false
},
"porting_date": {
"type": "Date",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"carrier_name": {
"type": "Text",
"mandatory": false
},
"previous_carrier_name": {
"type": "Text",
"mandatory": false
},
"tracking_id": {
"type": "Text",
"mandatory": false
}
}
},
{
"id": "recording_state_change",
"validation-type": "strict",
"fields": {
"recording_id": {
"type": "Text",
"mandatory": true
},
"reason_code": {
"type": "Text",
"mandatory": false
},
"start_time": {
"type": "Date",
"mandatory": false
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"end_time": {
"type": "Date",
"mandatory": false
},
"reason_description": {
"type": "Text",
"mandatory": false
},
"state": {
"type": "Text",
"mandatory": true
},
"call_external_id": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
},
"recording_external_id": {
"type": "Text",
"mandatory": true
},
"call_id": {
"type": "Text",
"mandatory": true
}
}
},
{
"id": "sender_id_recipient_consent_change",
"validation-type": "strict",
"fields": {
"company-id": {
"type": "Integer",
"mandatory": false
},
"sender_id_id": {
"type": "Text",
"mandatory": true
},
"consent_status": {
"type": "Text",
"mandatory": true
},
"recipient_address": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
}
}
},
{
"id": "sender_id_state_change",
"validation-type": "strict",
"fields": {
"reason_code": {
"type": "Text",
"mandatory": true
},
"previous_state": {
"type": "Text",
"mandatory": true
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"sender_id_id": {
"type": "Text",
"mandatory": true
},
"new_state": {
"type": "Text",
"mandatory": true
},
"reason_description": {
"type": "Text",
"mandatory": true
},
"application_id": {
"type": "Integer",
"mandatory": false
}
}
},
{
"id": "truedisconnect_event",
"validation-type": "strict",
"fields": {
"number": {
"type": "Text",
"mandatory": true
},
"previous_carrier_id": {
"type": "Text",
"mandatory": false
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"previous_carrier_name": {
"type": "Text",
"mandatory": false
},
"tracking_id": {
"type": "Text",
"mandatory": false
},
"deactivation_date": {
"type": "Date",
"mandatory": true
}
}
}
]
}
}get
Get the event type and associated fields for a give event
get /event-types/{CODE}
Get the event type and associated fields for a give event
URI Parameters
- CODE: required (string)
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"validation-type": {
"type": "string"
},
"fields": {
"type": "object",
"properties": {
"output_file_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"company-id": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"file_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"job_name": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"job_exec_complete_timestamp": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"error_file_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"error_details_file_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"file_name": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"job_exec_status": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"schedule_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
},
"execution_uri": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
}
}
}
}
}
},
"example": {
"id": "aba_job_completed",
"validation-type": "strict",
"fields": {
"output_file_uri": {
"type": "Text",
"mandatory": false
},
"company-id": {
"type": "Integer",
"mandatory": false
},
"file_uri": {
"type": "Text",
"mandatory": true
},
"job_name": {
"type": "Text",
"mandatory": true
},
"job_exec_complete_timestamp": {
"type": "Date",
"mandatory": true
},
"error_file_uri": {
"type": "Text",
"mandatory": false
},
"error_details_file_uri": {
"type": "Text",
"mandatory": false
},
"file_name": {
"type": "Text",
"mandatory": true
},
"job_exec_status": {
"type": "Text",
"mandatory": true
},
"schedule_uri": {
"type": "Text",
"mandatory": true
},
"execution_uri": {
"type": "Text",
"mandatory": true
}
}
}
}event-delivery-attempts
get
Get All event delivery attempts information
get /event-delivery-attempts
Get All event delivery attempts information
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"paged-result": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
},
"attempts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"event-id": {
"type": "string"
},
"event-type": {
"type": "string"
},
"event-body": {
"type": "string"
},
"event-timestamp": {
"type": "string"
},
"topic": {
"type": "string"
},
"delivery-status": {
"type": "string"
},
"del-cfg-nm": {
"type": "string"
},
"del-addr": {
"type": "string"
},
"attempt-number": {
"type": "integer"
},
"attempt-result": {
"type": "string"
},
"attempt-timestamp": {
"type": "string"
},
"attempt-http-response-status": {
"type": "integer"
},
"attempt-http-response-body": {
"type": "string"
}
}
}
}
},
"example": {
"paged-result": {
"offset": 0,
"limit": 50
},
"attempts": [
{
"event-id": "8KL0fnzlSC6PhN7nc7Oh7w",
"event-type": "truedisconnect_event",
"event-body": "{\n \"number\": \"+18139714110\",\n \"previous_carrier_id\": \"1025\",\n \"previous_carrier_name\": \"Guru\",\n \"tracking_id\": \"1642575360\",\n \"deactivation_date\": \"2017-06-28T04:00:00Z\"\n}",
"event-timestamp": "2017-10-28T17:15:31Z",
"topic": "NIS-Events",
"delivery-status": "SUCCESS",
"del-cfg-nm": "sai",
"del-addr": "https://putsreq.com/DUnYuHkpF7AareURlCAy",
"attempt-number": 1,
"attempt-result": "SUCCESS",
"attempt-timestamp": "2017-10-28T17:15:32Z",
"attempt-http-response-status": 200,
"attempt-http-response-body": "Hello World"
},
{
"event-id": "hc4lnloTSK2aSvrLKiDpSA",
"event-type": "truedisconnect_event",
"event-body": "{\n \"number\": \"+18139714110\",\n \"previous_carrier_id\": \"1025\",\n \"previous_carrier_name\": \"AT@$# T WIRELESS\",\n \"tracking_id\": \"1642575360\",\n \"deactivation_date\": \"2017-06-28T04:00:00Z\"\n}",
"event-timestamp": "2017-10-28T17:14:54Z",
"topic": "NIS-Events",
"delivery-status": "SUCCESS",
"del-cfg-nm": "sai",
"del-addr": "https://putsreq.com/DUnYuHkpF7AareURlCAy",
"attempt-number": 1,
"attempt-result": "SUCCESS",
"attempt-timestamp": "2017-10-28T17:14:54Z",
"attempt-http-response-status": 200,
"attempt-http-response-body": "Hello World"
}
]
}
}event-buffer-files
get
Get a list of event buffer files for a given company
get /event-buffer-files
Get a list of event buffer files for a given company
Headers
- Authorization: required (string)
- user-token: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"file-id": {
"type": "integer"
},
"del-cfg-id": {
"type": "string"
},
"del-cfg-nm": {
"type": "string"
},
"file-status": {
"type": "string"
},
"opened": {
"type": "string"
},
"closed": {
"type": "string"
}
}
}
},
"paged-result": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
}
}
},
"example": {
"files": [
{
"file-id": 601,
"del-cfg-id": "1449",
"del-cfg-nm": "trueeventDisconnect",
"file-status": "ARCHIVED",
"opened": "2017-07-12T19:05:01Z",
"closed": "2017-07-12T19:10:01Z"
},
{
"file-id": 603,
"del-cfg-id": "1449",
"del-cfg-nm": "trueeventDisconnect",
"file-status": "ARCHIVED",
"opened": "2017-07-12T19:55:23Z",
"closed": "2017-07-12T20:00:01Z"
},
{
"file-id": 602,
"del-cfg-id": "1449",
"del-cfg-nm": "trueeventDisconnect",
"file-status": "ARCHIVED",
"opened": "2017-07-12T19:11:56Z",
"closed": "2017-07-12T19:15:01Z"
}
],
"paged-result": {
"offset": 0,
"limit": 1000
}
}
}