Contact

IMPORTANT!

Server Key ID and Server Key Secret will be used to construct a request and add as a HTTP Header. To construct a request, please format your generated Server Key ID and Server Key Secret and wrap it to Base64, so the format will be like this:

encodeToBase64(SERVER_KEY_ID:SERVER_KEY_SECRET) *don't forget to add colon (:) between Server Key ID and Server Key Secret

Then, put the base64 string on your HTTP Header Field with key “Server-Key” and then construct URL request and parameter for the request.

Sync Contacts

Update and/or delete contacts.

Note that contact works one-way. A user may add another user to his/her contact list without requiring the added user to do the same in return. It works just like how a contact/phone book should.

IMPORTANT!

Contact deletion always run the last. If the contact list contains duplicate owner-contact pairs with one's isDeleted set to true, then that record will always be deleted.

POST

BASE_URL/v1/server/contact/sync

example:
https://taptalk.io/v1/server/contact/sync

Request

Field	Type	Description
contacts	string	(101) The list of contacts to be synced.
ownerXCUserID	string	(102) The XC user ID who owns the contact.
contactXCUserID	string	(103) The contact's XC user ID.
isDeleted	string	(104) If the contact is to be deleted, may be omited if false.

Request Example

{
    "contacts": [
        {
            "ownerXCUserID": "1",
            "contactXCUserID": "2"
        },
        {
            "ownerXCUserID": "1",
            "contactXCUserID": "6",
            "isDeleted": false
        },
        {
            "ownerXCUserID": "1",
            "contactXCUserID": "9",
            "isDeleted": true
        },
        {
            "ownerXCUserID": "6",
            "contactXCUserID": "1",
            "isDeleted": false
        }
    ]
}

Success 200

Field	Type	Description
countInserted	long	Number of contact rows inserted.
countDeleted	long	Number of contact rows deleted.

Success Response

{
  "status": 200,
  "error": {
    "code": "",
    "message": "",
    "field": ""
  },
  "data": {
    "countInserted": 3,
    "countDeleted": 1
  }
}

Error 4xx

Name	Description
ParamValidationFailed	The parameter validation failed.
HeaderValidationFailed	The request header validation failed.

ParamValidationFailed

{
  "status": 400,
  "error": {
    "code": "40002",
    "message": "Param 'contacts' cannot be empty",
    "field": "101"
  },
  "data": {}
}

HeaderValidationFailed

{
  "status": 400,
  "error": {
    "code": "40001",
    "message": "Request headers are required (Server-Key)",
    "field": ""
  },
  "data": {}
}