Sample JSON data exchange format for the address book - update and full methods.

[
    {
        "id": 1,
        "name": "Sebastian Chojnacki",
        "users": [
            {
                "name": "sebac",
                "mark": 1,
                "os": "ios"
            }
        ],
        "numbers": [
            {
                "number": 48555555555,
                "mark": 1,
                "os": "ios"
            },
            {
                "number": 48666666666,
                "mark": 1,
                "os": "and"
            }
        ],
        "emails": [
            {
                "email": "alias@domena.com",
                "mark": 1,
                "os": "ios"
            },
            {
                "email": "alias@domena.pl",
                "mark": 0,
                "os": "and"
            }
        ]
    },
    {
        "id": 2,
        "name": "Jan Kowalski",
        "users": [
            {
                "name": "kow1",
                "mark": 1,
                "os": "ios"
            },
            {
                "name": "kow2",
                "mark": 1,
                "os": "bb"
            }
        ],
        "numbers": [
            {
                "number": 48555145212,
                "mark": 0,
                "os": ""
            }
        ]
    }
]

There is no limit of numbers for a given contact. The numbers must be written in the international format - i.e. with the country code.

Sample JSON data exchange format for the address book - remove method.

[3,4,5]

Sample JSON format for the verify method.

{
 "acc": 120,
 "anc": 125,
 "vcc": 10,
 "vnc": 12,
 "vuc": 2
}

The verify method is used to verify the number of contacts between the local(device) and global(server) database. The JSON object includes the following fields:
 - acc - the number of all contacts
 - anc - number of all numbers for all contacts(contacts can have multiple numbers)
 - vcc - number of all vippie* contacts
 - vnc - the sum of all numbers for all vippie* contacts 
 - vuc - the number of all vippie* ID for all vippie* accounts 

*-vippie contact - is a person who is using our app and we have him in our contact list, such contact can have a multiple numbers registered

After sending all the above parameters to the server, we will receive code 200 as the "cl" parameter, which means that all information is consistent. When the server returns the code 413, it means that there are differences in the global database and contacts should be synchronized using the full method.

The list of RCS users. Reply from the server

Response method http

In response, a token will be sent, e.g.: c9bc64e8-f7e4-4439-9dbe-6d9b8180f1a1

The token is then sent in a request to the /contacts.ashx method with the 'sm' parameter with the 'check' value:

l=1510049&p=KJu92Nz1ysBPE&cl=c9bc64e8-f7e4-4439-9dbe-6d9b8180f1a1&sm=check

In case of an error, the following code will be returned:

In other cases, JSON with a list of RCS users will be returned.

{"add":{"users":[{"id":56,"u":"chrisogl1","l":"1129392","os":"and"}]}}

When sending a list of contacts larger than 300, the list should be divided into smaller packages (e.g. 300 items each) and sent one by one. After sending the first package, we receive a token, we send the token to check whether there is already a JSON list, if so, after receiving it, we send the next package. We repeat the procedure until the entire book has been sent. During this time, you should update the contact list in the UI and show the RCS users every time the JSON list arrives.

Response method sms

After sending the list to the server, a separate process will return in the form of an SMS or a few text messages (depending on the number of contacts) a list of contacts that already exist in the system as users.

SMS content for phone contacts

SIPLINK_COMMAND : Contacts add : {"phones":[{"id":1,"n":48502159212,"l":1000000,"os":"ios"},{"id":2,"n":48502159211,"l":1000010,"os":"and"}]}

SIPLINK_COMMAND : Contacts del : {"phones":[{"id":3,"n":48502159200},{"id":4,"n":48502159201}]}

Blocking a contact

This method allows you to block selected contacts. To block a given contact or contacts, please send the following parameters:

Parameters

[
  "100247",
  "100057"
]

Return value

SIPLINK_COMMAND : Contacts add : {"blocked":"1000200"}

Unblocking a contact

Parameters

[
  "100247",
  "100057"
]

Return value

SIPLINK_COMMAND : Contacts add : {"unblocked":"1000200"}

Odczyt zablokowanych kontaktów

Return value

{
  "in": [
    "login1",
    "login2",
    "login3"
  ],
  "out": [
    "login4",
    "login5",
    "login6"
  ]
}

where:

• in - contains a list of SIP logins that have been blocked by a given user
• out - contains a list of SIP logins that have blocked a given user