Initiate WAP push

Allows to initiate WAP sessions.

application/json

Request Body required

• appId WapAppId required

  WAP application identifier

• customerMsisdn +234'10 digits' or 234'10 digits' or +0'10 digits' or 0'10 digits' or '10 digits' required

  Possible values: Value must match regular expression ^\+?(234|0)?\d{10}$

  MSISDN (phone number), available formats:

  • +234'10 digits' - for example: +2341234567890
  • 234'10 digits' - for example: 2341234567890
  • +0'10 digits' - for example: +01234567890
  • 0'10 digits' - for example: 01234567890
  • '10 digits' - for example: 1234567890
• process object

  Custom process to start the session with, with optional defined params

  id string required

  ID of the custom process

  params object required

  Custom process params, in key-value format

Responses

• 200

---

Response

application/json

• Schema
• Example (from schema)
• Initialization succeeded
• Initialization failed

---

Schema

• oneOf
  • InitWapPushSessionSuccessResponse
  • InitWapPushSessionFailureResponse

  ---
• status string required

  Possible values: [OK]

  Status indicating that request succeeded

• message string required
• sessionId string required

  ID of initiated session

status string required

Possible values: [FAILED]

Status indicating that request failed

message string required

Failure description

{
  "status": [
    "OK"
  ],
  "message": "string",
  "sessionId": "string"
}

{
  "status": "OK",
  "message": "Session initiated with id 02c9488d-311b-4121-bfe4-85c4394be92d",
  "sessionId": "02c9488d-311b-4121-bfe4-85c4394be92d"
}

{
  "status": "FAILED",
  "message": "Application with id 12345678 was not found"
}