Message2Give Logo
Message2Give DocsVersion 1.2.8

Validation

Validate a phone number's connection and ability to be contacted.

There are some limitations surrounding when number validation requests can be processed. The following rules determine the timeframes based on the number prefix.

First match applies (numbers starting with):

  • 614: Midnight to midnight (24/7).

  • 617: 9am Brisbane time to 8pm Brisbane time.

  • 618: 9am Perth time to 8pm Adelaide time.

  • 61: 9am Sydney time to 8pm Sydney time.

  • 64: 9am NZ time to 8pm NZ time.

Validation requests that are submitted outside will be queued and processed as soon as possible.


POST Validation Number

https://api.app.message2give.com/2019-01-23/validations

Authentication Required: Yes

Description

Submit a number for validation. Validation will evaluate a phone number's connection and ability to be contacted.

This endpoint will give you an "id" in the response. Use this ID in the GET Validation Number endpoint to retrieve the result of the validation.

Body Properties

  • number: the E.164-formatted number (string) you wish to validate.
Example JSON Response
{
    "id": "123456789",
    "status": "OK"
}

Code Snippet


GET Validation Number

https://api.app.message2give.com/2019-01-23/validations/{validation-id}

Authentication Required: Yes

Description

Retrieve the results of a number's validation. The validation process may take some time to finish.

Path Parameters

  • validation_id: the ID of the number you are validating. This ID can be found in the API response after submitting a number for validation.
Example JSON Response
{
  "status" : "OK",
  "validations" : [
    {
        "id" : "123456789",
        "content" : "Connected 505-03 (Vodafone)",   // }
        "receipts" : {                               // } Absent when result
          "connected" : "2021-12-07T12:09:24.214Z"   // } is pending.
        },                                           // }
        "number" : "61432123456",
        "created" : "2021-12-07T12:09:20.277Z"
    }
  ]
}

Code Snippet

How is this guide?

On this page