(Outgoing) Add - server

Usage

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

WebSocket event

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

Event name: contacts@add

Object

KeyTypeExtraDescription
custom_idstring
required
Unique identifier (custom_id) of the sender (1-64 characters)
contactContact
required
Contact object

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",
    "displayName": "Hank",
    "number": "555-6671"
  }
}

Response

Unfortunately, there is no response in this version.

What's next?

Outgoing events

Powered by Doctave