Connecting to Ansible Gateway

Preparing an Ansible Gateway integration. Public onboarding and token issuance are not open. Examples describe the compatible interface, not working service access.

Index

• Before you Start
• Sending Auth Codes
• Checking the Authorization Status
• Receiving Reports

Before you Start

Check Gateway status first. Website sign-in uses separate Ansible authorization documentation.

Funding your Account

Public Gateway top-ups are not enabled. Do not pay third-party sellers for access.

Obtaining your API Token

Open token issuance has not been announced. An integration token belongs on your server and must stay out of browser code and public logs.

Querying the API

Once access is provided, use the agreed HTTPS address. GATEWAY_BASE_URL below is a configuration placeholder, not a published service address.

POST GATEWAY_BASE_URL/METHOD_NAME
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

Sending Auth Codes

Obtain the number with the user’s consent and validate its format. Example request fields:

sendVerificationMessage
{ "phone_number": "+15555550100", "code": "123456", "ttl": 60 }

Checking that codes can be delivered

An eligibility check does not establish successful code delivery.

checkSendAbility
{ "phone_number": "+15555550100" }

Revoking Codes

The reference describes revokeVerificationMessage. Also limit code expiry and attempts in your own service.

Checking the Authorization Status

Bind the result to the specific request and verify it server-side.

checkVerificationStatus
{ "request_id": "REQUEST_ID", "code": "123456" }

Receiving Reports

See the API reference for report formats. Callback availability and connection parameters must be verified for the specific integration.