Offline history

Metoda dostępna pod adresem: /ch.ashx . 

This method allows you to download the history of conversations and messages for a given user. This method contains two parameters: cm and pm. The cm parameter describes the name of the method, while the pm parameter describes the parameters of a given method. The following methods are available within conversation history: setRead, setDownloaded, delRecord, getList.

Authorization

The method requires authorization using basic authentication. Please use your SIP account login and password.

Method description:

Mark the list of records as read

Each record in the history has a field called "new" with values 0 or 1. All new records are set to "new" = 1. To change the status of a given message or group of messages to 0, i.e. read, you need to call the ch.ashx method with the parameters:

Download the conversation list

[
    {
        "id": 1405573,
        "new": 1,
        "rs": "1000225",
        "dn": "48130313058",
        "s": "v",
        "sn": "on",
        "sb": "in",
        "dts": "2014-02-21T09:46:14",
        "dte": "",
        "mid": "",
        "mb": "",
        "cd": 0
    },
    {
        "id": 1174223,
        "new": 1,
        "rs": "1317111",
        "dn": "vippie ID",
        "s": "m",
        "sn": "on",
        "sb": "out",
        "dts": "2014-03-05T14:24:34",
        "dte": "2014-03-05T14:24:35",
        "mid": "35635",
        "mb": "Message content",
        "cd": 0
    },
....
]

where:

id - identifier of a given message in the conversation history

new - message status: 1 - unread, 0 - read

rs - resource - in the case of source onnet it is the sip login, in the case of offnet it is the caller ID of the caller.

dn - display name

s - source, available values: c - call, f - call failed, m - message, v - voicemail, s - SIPLINK_COMMAND

sn - source network, available values: on -> on-net or off -> off-net

sb - source box, available values: in or out

sdt - event date - in the case of calls, this is the date the call ended.

mid - message id - message ID sent by dialer in the sip message body

mb - message body -Message content

ms - message status - available values s - sent, d - delivered, r - read, c - deleted

cd - call duration - connection length in seconds.

Retrieving the conversation list by modification date

To download the history, call the ch.ashx method with the cm=getList parameter and additionally set the If-Modified-Since and Range headers.

• The If-Modified-Since header instructs the server to send records only if they have been modified since a given date. If the data has not changed, the server should send the response code 304 - HTTP STATUS: 304 Not Modified, otherwise the server will return a list of records in the form of a JSON array.
• The Range header specifies what part of the data the dialer expects. This header should be provided in the format records=start_position-end_position. If the dialer does not send the Range header, the server will default to records=0-99, i.e. it will return the first 100 records.

Example - retrieving records without specifying If-Modified-Since and Range:

Request body
cm=getList

Content-Range: records 0-99/5124
Last-Modified: Tue, 21 Nov 2014 12:45:26 GMT
 
Response body
[
    {
        "id": 1405573,
        "new": 1,
        "rs": "1000225",
        "dn": "48130313058",
        "s": "v",
        "sn": "on",
        "sb": "in",
        "dts": "2014-02-21T09:46:14",
        "dte": "",
        "mid": "",
        "mb": "",
        "cd": 0
    },
    {
        "id": 1174223,
        "new": 1,
        "rs": "1317111",
        "dn": "vippie ID",
        "s": "m",
        "sn": "on",
        "sb": "out",
        "dts": "2014-03-05T14:24:34",
        "dte": "2014-03-05T14:24:35",
        "mid": "35635",
        "mb": "tre?? wiadomo?ci",
        "cd": 0
    },
....
]
 

{
 "th" : true,
 "rs" : "sip_login",
 "gid": 123,
 "sn" : "on",
 "sdt": "2018-03-02T18:00:20"
}
 

{
 "th":true 
}
 

{
 "rs":"sip_login",
 "sn":"on"
}

{
 "rs":"sip_login",
 "sn":"on",
 "sdt":"2018-01-20T20:20:11"
}

{
 "gid":123
}

{
 "gid":123,
 "sdt":"2018-01-20T20:20:11"
}

Retrieving information about the message

To retrieve information about a given message, you need to call the /history method with the following parameters:

{
 "mid":"MESSAGE-ID",
 "rs": "1317111"
}

{
 "st": "2014-03-17T18:08:20",
 "cf": "2014-03-17T18:08:20",
 "rd": "2014-03-17T18:08:20"
}

setting up a Label

To set the label, you need to call the /history method with parameters:

{
 "lbl": 0,
 "s"  : "",
 "mid": [""],
 "rs" : [""],
 "cid": [""],
 "gid": [1]
}

{
 "lbl": 8,
 "s"  : "g",
 "gid": [567]
}

{
 "lbl": 8,
 "s"  : "g",
 "gid": [567]
 "mid": ["123","124","125","126"]
}

In response we will receive:

{
 "nra": 12
}

Delete the message list

To delete the list of messages, you need to call the ch.ashx method with the following parameters:

Mark the attachment in the message as downloaded

After successfully downloading the file, set the attachment status to correct. Calling the function removes the file identifier from the message body. Example:

 ~[ATT RID:'1999999' type:'0' ext:'jpg']

 ~[ATT RID:'' type:'0' ext:'jpg']

To set the attachment status, you need to call the ch.ashx method with the following parameters: