(Outgoing) Remove - server

Usage

When a contact is removed by the player in-game, from his in-game phone, you need to send the information to iPear. You can remove a specific contact from the server with the websocket.

WebSocket event

You need to emit an event with the following name and data:

Event name: contacts@remove

Object

KeyTypeExtraDescription
custom_idstring
required
Unique identifier (custom_id) of the sender (1-64 characters)
contact_uidstring
required
Unique identifier of the contact linked to this phone_number and custom_id (example: the column "id" in your database) (1-32 characters)

Important

Response object must respect every type rule. If any structure isn't respected, your request will be rejected for "bad-request".

Example

{
  "custom_id": "1234",
  "contact_uid": "8756"
}

Response

Unfortunately, there is no response in this version.

What's next?

Outgoing events

Powered by Doctave