PhoneNumber

POST /v1/form/update

Below is an example illustrating the consumable format of PhoneNumberComponent. The 'NEXT' status indicates that you haven't reached the end of the form yet. Each question is uniquely identified by an ID stored in 'questionId'.

Object

{
    "status": "NEXT",
    "refId": "SLH-4UN0RDF0990D",
    "question": {
        "questionId": "58faf398-f0dc-4f93-9a18-81304d1fcae9",
        "question": "What is your phone number?",
        "kind": "PhoneNumberComponent",
        "settings": {}
    },
    "review": [
        ...,
        {
            "id": "1ee35298-12ea-4f4d-a326-df44ad7c9fb3",
            "question": "How old are you?",
            "answer": "25"
        }
    ],
    "message": null,
    "invoice": {
        "title": "Question Engine All cards No logic",
        "quantity": 1,
        "currency": "XOF",
        "totalCost": 1000.0
    }
}

Response to the question

Headers

Name	Value
Content-Type	application/json
CLIENT_ID	<client id>

Body

In addition to the API keys specified in the Headers, ensure to include the eServiceId, refId, questionId. Upon a successful request, you will receive the next question. You'll recognize reaching the end of the form when the status is 'COMPLETED'.

values class field(s)	Format
value	E.164 formatted phone number

Example

Request Body

{
    "eServiceId": "663835dfae67d8704b6752b7",
    "refId": "SLH-4UN0RDF0990D",
    "questionId": "58faf398-f0dc-4f93-9a18-81304d1fcae9",
    "values": {
        "value": "[phone]"
    }
}

200

400