Sinch Contact Center Restful Outbound Campaign Interface (OBI) API documentation version v1

http://localhost:8080/RI/obi

Description

This interface provides data of outbound campaings.

Request Header Data Requirements

To GET JSON response, the request must have "Accept = application/json" header.

To GET XML response, the request should have "Accept = application/xml" header.

To POST/PUT JSON data, the request must have "Content-Type = application/json" header.

To POST/PUT XML data, the request should have "Content-Type = application/xml" header.

POST should also have "Accept = text/html" header. It returns the ID of the created object. POST also returns Location header which contains the ID. POST returns code 201 (Created).

PUT and DELETE do not have any response, instead they return code 204 (No Content).

/campaigns

Collection of campaigns.

get

get

Get a list of campaigns.

get

Entity representing a campaign.

get

Get the campaign with campaignId = {campaignId}.

Get the campaign with campaignId = {campaignId}.

URI Parameters

  • campaignId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(string - minLength: 32 - maxLength: 32)

    Added by the system

  • name: required(string)
  • dialerId: required(string - minLength: 32 - maxLength: 32)
  • dialerName: (string)
  • dialingMode: required(string)
  • status: (one of Passive, Active, Handled, Expired, Invalid, Deleted)
  • dialerStatus: (one of OPEN, CLOSING, CLOSING2, CLOSED, PASSIVE, COMPLETED, SUSPEND, EXPIRED, SHUTDOWN)
  • queueId: required(string - minLength: 32 - maxLength: 32)
  • queueName: (string)
  • customIvrNumber: (string)
  • total: (integer)
  • handled: (integer)
  • notHandled: (integer)
  • maxCalls: (integer)
  • filtered: (integer)
  • startDate: (datetime)
  • endDate: (datetime)
  • registered: required(datetime)
  • timeZone: (string)

Example:

{
    "notHandled": 5,
    "dialerName": "Queue Dialer",
    "total": 10,
    "registered": "2020-09-25T07:07:50.243Z",
    "dialerId": "88B8B41C99E6484A94F402EA5E465FC5",
    "dialer": "88B8B41C99E6484A94F402EA5E465FC5",
    "endDate": "2021-02-20T22:00:00Z",
    "startDate": "2020-12-20T22:00:00Z",
    "handled": 5,
    "dialerStatus": "PASSIVE",
    "maxCalls": 0,
    "filtered": 0,
    "dialingMode": "PREDICTIVE",
    "name": "Test Campaign",
    "timeZone": "Europe/Berlin",
    "queueId": "63AA93F493A54C5A8597FCFA670B2382",
    "status": "Passive",
    "queueName": "Test Queue",
    "id": "8A7C98EAF1164F2FAA93B98EECB95D76"
}

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

put

put

Value can be one of Passive, Active.

Value can be one of Passive, Active.

URI Parameters

  • campaignId: required(string)

Body

Media type: text/plain

Type: string

Example:

Active

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

get post

Collection of customers.

get

Get a list of customers.

post

Add a new customer.

Get a list of customers.

URI Parameters

  • campaignId: required(string)

Query Parameters

  • includeScript: (string - default: false)

    includes script to result

    Example:

    includeScript=true
  • any fields: (string)

    &field1=value1&field2=value2...
    Values may contain patterns * and ?
    Valid searchable fields: externalId, numbers, result, callResult, classifier, callCount, lastBNumber, agentId, dialingMode, previewTime, priority, timeZone

    Example:

    callResult=SUCCESS*
  • date: (string)

    Search for customers that have the date value after the given UTC time

    Example:

    date=2020-06-29T12:00:00.000Z
  • dateEnd: (string)

    Search for customers that have the date value before the given UTC time

    Example:

    dateEnd=2020-07-29T12:00:00.000Z
  • modificationDate: (string)

    Search for customers that have the modificationDate value after the given UTC time

    Example:

    modificationDate=2020-04-29T12:00:00.000Z
  • modificationDateEnd: (string)

    Search for customers that have the modificationDate value before the given UTC time

    Example:

    modificationDateEnd=2020-07-29T12:00:00.000Z
  • attributeName: (string)

    Search item by attribute name.

    Example:

    attributeName=classification
  • attributeValue: (string)

    Search by value of the attribute, attributeName parameter is mandatory in case attributeValue is given.

    Example:

    attributeValue=gold

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: customers

  • id: required(string - minLength: 32 - maxLength: 32)

    Added by the system

  • externalId: required(string)
  • numbers: required(string)
  • result: (string)
  • callResult: (string)
  • classifier: (string)
  • callCount: (integer)
  • lastBNumber: (integer)
  • date: (datetime)
  • agentId: (string)
  • dialingMode: (one of PREVIEW, PREDICTIVE)
  • previewTime: (integer)
  • priority: (integer)
  • modificationDate: (datetime)
  • timeZone: (string)
  • attributes: (array of object)

    Items: items

    • name: required(string)
    • value: required(string)
  • script: (object)
    • name: required(string)
    • answers: required(array of object)

      Items: items

      • question: required(string)
      • answer: required(string)

Example:

[{
       "attributes": {
           "attribute": [
               {
                   "name": "City",
                   "value": "New York"
               },
               {
                   "name": "Classification",
                   "value": "Gold"
               },
               {
                   "name": "Address",
                   "value": "StreetAddress10"
               },
               {
                   "name": "First Name",
                   "value": "Kathy"
               },
               {
                    "name": "Phone1",
                    "value": "0215428754"
               }
           ]
       },
        "script": {
            "answers": [
                {
                    "answer": "Other",
                    "question": "If you would now buy a new tennis racket, which of the following brands would you prefer?
                },
                {
                    "answer": "yes",
                    "question": "Would you be interested to visit our store so we can book an expert to introduce you these rackets in more details?"
                },
                {
                    "answer": "Within 6 months",
                    "question": "OK. When do you think you are going to update your racket so we can give you an call to discuss what we can offer at that time?"
                }
            ],
            "name": "Tennis Sales Script"
        },
       "result": "SUCCESS",
       "date": "9999-12-31T23:59:59Z",
       "dialingMode": "PREDICTIVE",
       "lastBNumber": 0,
       "callCount": 0,
       "modificationDate": "2020-09-29T12:58:28.393Z",
       "externalId": "10",
       "numbers": "0215428754",
       "id": "5C7A1B1A001848B7A86000E10E3B9D5B"
   },
   {
        "attributes": {
            "attribute": [
                {
                    "name": "City",
                    "value": "New York"
                },
                {
                    "name": "ExternalId",
                    "value": "7"
                },
                {
                    "name": "Classification",
                    "value": "Gold"
                },
                {
                    "name": "Postcode",
                    "value": "10001"
                },
                {
                    "name": "Company",
                    "value": "HighCom"
                },
                {
                    "name": "Address",
                    "value": "StreetAddress7"
                },
                {
                    "name": "First Name",
                    "value": "Julie"
                },
                {
                     "name": "Phone1",
                     "value": "951254875"
                },
                {
                     "name": "Phone2",
                     "value": "951254875"
                }
            ]
        },
        "result": "SUCCESS",
        "date": "9999-12-31T23:59:59Z",
        "lastBNumber": 0,
        "callCount": 0,
        "modificationDate": "2020-09-29T12:58:28.393Z",
        "externalId": "7",
        "numbers": "951254875;951254875",
        "id": "3B3BAFB4FD1444478DBF0658EDF389CC"
    }
}]

HTTP status code 400

Bad Request

Body

Media type: text/plain

Type: any

Example:

Invalid GUID: '2B8ED95B0EC911E79675005056A75D9'

Add a new customer.

URI Parameters

  • campaignId: required(string)

Body

Media type: application/json

Type: object

Properties
  • id: required(string - minLength: 32 - maxLength: 32)

    Added by the system

  • externalId: required(string)
  • numbers: (string)

    Customer's phone numbers separated with semicolon (;). Customer can have up-to 3 numbers. You can define customer phone numbers either by using this field, or by specifying attributes attributes Phone1, Phone2 and Phone3. Note: in case numbers is given, the attributes are ignored. It is required to provide phone numbers either by this property or by attributes.

  • date: (datetime)
  • agentId: (string)
  • dialingMode: (one of PREVIEW, PREDICTIVE)
  • previewTime: (integer)
  • priority: (integer)
  • modificationDate: (datetime)
  • timeZone: (string)
  • attributes: (array of object)

    Attributes of the customer. Note: attributes Phone1, Phone2 and Phone3 are created based on numbers property if that is defined in data. If numbers is not specified, it is mandatory to have at least attribute Phone1.

    Items: items

    • name: required(string)
    • value: required(string)

Example:

{
       "attributes": {
           "attribute": [
               {
                   "name": "City",
                   "value": "New York"
               },
               {
                   "name": "Classification",
                   "value": "Gold"
               },
               {
                   "name": "Address",
                   "value": "StreetAddress10"
               },
               {
                   "name": "First Name",
                   "value": "Kathy"
               }
           ]
       },
       "externalId": "10",
       "numbers": "0215428754;98521542",
       "timeZone": "Europe/Helsinki"
   }
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get delete

Entity representing a customer.

get

Get the customer with customerId = {customerId}.

delete

Delete the customer.

Get the customer with customerId = {customerId}.

URI Parameters

  • campaignId: required(string)
  • customerId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(string - minLength: 32 - maxLength: 32)

    Added by the system

  • externalId: required(string)
  • numbers: required(string)
  • result: (string)
  • callResult: (string)
  • classifier: (string)
  • callCount: (integer)
  • lastBNumber: (integer)
  • date: (datetime)
  • agentId: (string)
  • dialingMode: (one of PREVIEW, PREDICTIVE)
  • previewTime: (integer)
  • priority: (integer)
  • modificationDate: (datetime)
  • timeZone: (string)
  • attributes: (array of object)

    Items: items

    • name: required(string)
    • value: required(string)
  • script: (object)
    • name: required(string)
    • answers: required(array of object)

      Items: items

      • question: required(string)
      • answer: required(string)

Example:

{
       "attributes": {
           "attribute": [
               {
                   "name": "City",
                   "value": "New York"
               },
               {
                   "name": "Classification",
                   "value": "Gold"
               },
               {
                   "name": "Address",
                   "value": "StreetAddress10"
               },
               {
                   "name": "First Name",
                   "value": "Kathy"
               },
               {
                    "name": "Phone1",
                    "value": "0215428754"
               }
           ]
       },
        "script": {
            "answers": [
                {
                    "answer": "Other",
                    "question": "If you would now buy a new tennis racket, which of the following brands would you prefer?
                },
                {
                    "answer": "yes",
                    "question": "Would you be interested to visit our store so we can book an expert to introduce you these rackets in more details?"
                },
                {
                    "answer": "Within 6 months",
                    "question": "OK. When do you think you are going to update your racket so we can give you an call to discuss what we can offer at that time?"
                }
            ],
            "name": "Tennis Sales Script"
        },
       "result": "SUCCESS",
       "date": "9999-12-31T23:59:59Z",
       "dialingMode": "PREDICTIVE",
       "lastBNumber": 0,
       "callCount": 0,
       "modificationDate": "2020-09-29T12:58:28.393Z",
       "externalId": "10",
       "numbers": "0215428754",
       "id": "5C7A1B1A001848B7A86000E10E3B9D5B"
   }

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

Delete the customer.

URI Parameters

  • campaignId: required(string)
  • customerId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found