Hooligram Documentation

Protocol V2

Verification

Code request

Client request

{
  "id": "<string>",
  "payload": {
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "type": "VERIFICATION_REQUEST_CODE_REQUEST"
}

Server success response

{
  "id": "<string>",
  "payload": {
  },
  "type": "VERIFICATION_REQUEST_CODE_SUCCESS"
}

Server failure response

{
    "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "VERIFICATION_REQUEST_CODE_FAILURE"
}

Code submit

Client request

{
  "id": "<string>",
  "payload": {
    "verification_code": "<string>"
  },
  "type": "VERIFICATION_SUBMIT_CODE_REQUEST"
}

Server success response

{
  "id": "<string>",
  "payload": {
  },
  "type": "VERIFICATION_SUBMIT_CODE_SUCCESS"
}

Server failure response

{
  "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "VERIFICATION_SUBMIT_CODE_FAILURE"
}

Authorization

Sign in

Client request

{
  "id": "<string>",
  "payload": {
    "country_code": "<string>",
    "phone_number": "<string>",
    "verification_code": "<string>"
  },
  "type": "AUTHORIZATION_SIGN_IN_REQUEST"
}

Server success response

{
  "id": "<string>",
  "payload": {
  },
  "type": "AUTHORIZATION_SIGN_IN_SUCCESS"
}

{
  "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "AUTHORIZATION_SIGN_IN_FAILURE"
}

Group

Create group

Client request

{
  "id": "<string>",
  "payload": {
    "group_name": "<string>",
    "member_sids": ["<string>"]
  },
  "type": "GROUP_CREATE_REQUEST"
}

Server success response

{
  "id": "<string>",
  "payload": {
    "group_id": "<int>"
  },
  "type": "GROUP_CREATE_SUCCESS"
}

Server failure response

{
  "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "GROUP_CREATE_FAILURE"
}

Leave group

Client request

{
  "id": "<string>",
  "payload": {
    "group_id": "<int>"
  },
  "type": "GROUP_LEAVE_REQUEST"
}

Server success response

{
  "id": "<string>",
  "payload": {
  },
  "type": "GROUP_LEAVE_SUCCESS"
}

Server failure response

{
  "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "GROUP_LEAVE_FAILURE"
}

Add new member

Client request

{
  "id": "<string>",
  "payload": {
    "group_id": "<int>",
    "member_sid": "<string>"
  },
  "type": "GROUP_ADD_MEMBER_REQUEST"
}

Server success response

{
  "id": "<string>",
  "payload": {
  },
  "type": "GROUP_ADD_MEMBER_SUCCESS"
}

Server failure response

{
  "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "GROUP_ADD_MEMBER_FAILURE"
}

Group update

Server request

{
  "id": "<string>",
  "payload": {
    "date_created": "<string>",
    "group_id": "<int>",
    "group_name": "<string>",
    "group_type": "<int>",
    "member_sids": ["<string>"]
  },
  "type": "GROUP_DELIVER_REQUEST"
}

Client success response

{
  "id": "<string>",
  "payload": {
    "group_id": "<int>"
  },
  "type": "GROUP_DELIVER_SUCCESS"
}

Client failure response

{
  "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "GROUP_DELIVER_FAILURE"
}

Messaging

Send message

Client request

{
  "id": "<string>",
  "payload": {
    "group_id": "<int>",
    "content": "<string>"
  },
  "type": "MESSAGING_SEND_REQUEST"
}

Server success response

{
  "id": "<string>",
  "payload": {
    "message_id": "<int>"
  },
  "type": "MESSAGING_SEND_SUCCESS"
}

Server failure response

{
  "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "MESSAGING_SEND_FAILURE"
}

Message update

Server request

{
  "id": "<string>",
  "payload": {
    "content": "<string>",
    "date_created": "<string>",
    "group_id": "<int>",
    "message_id": "<int>",
    "sender_sid": "<string>"
  },
  "type": "MESSAGING_DELIVER_REQUEST"
}

Client success response

{
  "id": "<string>",
  "payload": {
    "message_id": "<int>"
  },
  "type": "MESSAGING_DELIVER_SUCCESS"
}

Client failure response

{
  "id": "<string>",
  "payload": {
    "errors": ["<string>"]
  },
  "type": "MESSAGING_DELIVER_FAILURE"
}

Connection

Client request

{
  "id": "<string>",
  "payload": {
  },
  "type": "CONN_KEEP_ALIVE_REQUEST"
}

Server success response

{
  "id": "<string>",
  "payload": {
  },
  "type": "CONN_KEEP_ALIVE_SUCCESS"
}

Server failure response

{
  "id": "<string>",
  "payload": {
  },
  "type": "CONN_KEEP_ALIVE_FAILURE"
}