Offnet Provisioning

Table of Contents

Overview

By request, we can set up your account to load off network numbers for SMS/MMS provisioning and/or 911 (including Multi-Alert/Alert Groups) provisioning. Please contact your salesperson to start this process.

These two function calls will allow you to check if a number is supported for off network loading as well as queue a job to get numbers inserted and provisioned on our system.

Controller: /dids/offnet
Full Url: https://apiv1.teleapil.net/dids/offnet

Functions

/check

Full Url: https://apiv1.teleapi.net/dids/offnet/check

Arguments:

Info: This will check if we are able to provision an offnet number on our network.

Return:

{
    "success": {
        "5555555555": "Success",
        "5555555556": "Success"
    },
    "fail": {
        "555555555": "Invalid number"
    }
}

/submit

Full Url: https://apiv1.teleapi.net/dids/offnet/submit

Arguments:

Info: This will submit an offnet insert job. Please note that if you do not wish to have the SMS enabled on the number make sure to send it with enable_sms=no -- otherwise it will enable SMS, negating any previous SMS setup the numbers have already and possibly causing downtime.

Return:

{
    "success": [
        "5555555555",
        "5555555556"
    ],
    "fail": {
        "555555555": "Invalid USA/CAN number",
        "5555555554": "Number already loaded"
    },
    "jobid": 123
}

/list

Full Url: https://apiv1.teleapi.net/dids/offnet/list

Arguments:

Info: This will list all of the offnet jobs you have submitted (a job is submitting one batch of numbers). Here you can get the current status of each job.

/status

Full Url: https://apiv1.teleapi.net/dids/offnet/status

Arguments:

Info: This will give you a detailed look at a specific job, specified by jobid. It will return the insert status along with each number in that submitted job.