10DLC A2P v3 Provisioning APIs

Please note that these API docs are getting updated and subject to change.

API Specs

10DLC A2P v3 Provisioning API spec is available in OpenAPI format.

Process

At a high level, the provisioning process requires the following sequence of steps:

  1. Check Line Eligibility - verify that the phone number can be text-enabled.
  2. Provision Line - send request to provision the line.
    • Note: This step requires a campaign id to register the on.
  3. Check Line Status - check status of Line Provision or Line Cancel request.
    • Note: If a line has an active provisioning process (pending or completed), you must first wait for the initial provisioning to finish before you can delete or reprovision the line.
    • Note: Before taking further action on a phone number, ensure that its provisioning process has been fully completed.
  4. Delete Line - send request to deprovision a line, if necessary.
    • Note: Attempting to delete a line while it is in a provisioning process may result in a conflict or error.
    • Deprovisioning After a Number is Ported Away - if a number is ported away from Zipwhip, you are still required to submit a deprovision request.

Authentication

Details on the Authentication patterns for these APIs will be added at a later date.

Rate Limits

The system can handle up to 100 requests per second (RPS) for line actions. If you expect higher request volumes, please contact us to discuss scaling options.

Zipwhip requires that all customers who use the Provisioning tools secure proper authorization from the end user of record for each telephone number provisioned. Failure to secure proper authorization can lead to termination of your service agreement with Zipwhip. Refer to your Zipwhip service agreement for specific contractual requirements regarding provisioning telephone numbers.