API Documentation

API Endpoint

https://apicontrol.call48.com/api/v4

Api calls are made using GET/PUT/POST/DELETE and responses are returned as JSON objects.

To interact with the api use the follow endpoints: Live: https://apicontrol.call48.com/api/v4

Overview ¶

Request Format & Authorization

All API requests are initiated after successful Customer login. The Customer is required to login everytime the auth token is invalid or expired. The authorization token parameter must be included in every request in Headers only, this acts as your apikey. This parameter will be used to authenticate all requests after login.

Invalid Token Sample Response ¶

POST https://apicontrol.call48.com/api/v4/purchase

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 401,
  "error": "Unauthorized Access"
}

Invalid Token Sample Response
POST`/purchase`

If any API returns 401 in code parameter of the response body this indicates that the token has expired or is no longer valid, then call the Customer Login API again to generate a new Authorization token(this acts as your apikey to be used in every request under request Headers)

POST https://apicontrol.call48.com/api/v4/login

Responses200

Headers

Content-Type: application/json

Body

{
  "error": null,
  "data": {
    "token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6ImUxNTgwNzk5LWNmZTgtNGQ2Ni04NmExLWY1ODk5OTgwZGFlNSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMyOTc0MTMsImV4cCI6MTYxMzM4MzgxM30.siFjSoPRSLgImsMcVZ4ppWhaXdWuGcSBXaxoTm37cBjD0MEsTuwaJFecXGCeJh7i1aaFs6a2BlCeFiJ61dBR3Q"
  },
  "code": 200
}

Customer LogIn
POST`/login`

This API is used to authenticate the user creds & if successful, it returns a Authorization token in the response body on parameter “token” under “data” object, and this becomes your request “Authorization” Headers which you give in subsequent API calls.

URI Parameters

HideShow

user_name: string (required) Example: mark
Account Username
password: string (required) Example: password
Account Plain Password

POST https://apicontrol.call48.com/api/v4/admin_login

Responses200

Headers

Content-Type: application/json

Body

{
  "error": null,
  "data": {
    "token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6ImUxNTgwNzk5LWNmZTgtNGQ2Ni04NmExLWY1ODk5OTgwZGFlNSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMyOTc0MTMsImV4cCI6MTYxMzM4MzgxM30.siFjSoPRSLgImsMcVZ4ppWhaXdWuGcSBXaxoTm37cBjD0MEsTuwaJFecXGCeJh7i1aaFs6a2BlCeFiJ61dBR3Q"
  },
  "code": 200
}

SP Admin LogIn
POST`/admin_login`

URI Parameters

HideShow

user_name: string (required) Example: mark
Account Username
password: string (required) Example: password
Account Plain Password

DID ¶

DID Lookup ¶

GET https://apicontrol.call48.com/api/v4/search?type=local&state=GA&ratecenter=ATHENS&npa=706&nxx=510&limit=10

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": {
    "result": [
      {
        "did": "706-510-3027",
        "number": "706-510-3027",
        "npa": "706",
        "nxx": "510",
        "xxxx": "3027",
        "fax": "true",
        "tier": 1,
        "type": "local",
        "state": "GA",
        "ratecenter": "ATHENS",
        "locData": "2d80c0952d7869653547f0"
      }
    ],
    "loc": "1fccd99f2f65707c290bbe4fa3ad4ccbe31fd4f69ca5ce6160bc4534c4cb2b2dce08c093c3ca8b",
    "setup": "2.00000",
    "monthly": "1.00000"
  }
}

Search Local
GET`/search{?type}{&state}{&ratecenter}{&npa}{&nxx}{&limit}`

To perform this request you need to pass the did type local,intl,toll) the two digit code for the state (GA for Georgia) the retecenter, sate, the npa (the three first digits of the phone number), the nxx.

URI Parameters

HideShow

ratecenter: string (optional) Example: ATHENS
state: string (required) Example: GA
type: string (required) Example: local
npa: string (optional) Example: 706
nxx: string (optional) Example: 510
limit: number (required) Example: 10

GET https://apicontrol.call48.com/api/v4/search?type=toll&npa=706&limit=10

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": {
    "result": [
      {
        "npa": "741",
        "nxx": "852",
        "xxxx": "9632",
        "did_number": "7418529632"
      }
    ],
    "loc": "1fccd99f2f65707c290bbe4fa3ad4ccbe31fd4f69ca5ce6160bc4534c4cb2b2dce08c093c3ca8b",
    "setup": "2.00000",
    "monthly": "1.00000"
  }
}

Search Tollfree
GET`/search{?type}{&npa}{&limit}`

To perform this request you need to pass the did type (local,intl,toll) the two digit code for the state (GA for Georgia) the recenter for the sate AND state_id, the npa (the three first digits of the phone number), the nxx.

URI Parameters

HideShow

type: string (required) Example: toll
npa: string (optional) Example: 706
limit: number (required) Example: 10

GET https://apicontrol.call48.com/api/v4/search?type=intl

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "error": null,
  "data": [
    {
      "id": "c95727b7-3dfd-4205-8b2c-ea4fb45c9fb3",
      "name": "Arkhangelsk",
      "prefix": "8182",
      "features": [
        "voice",
        "voice_out"
      ],
      "requirements": true,
      "quantity": 1,
      "setup": "0.0",
      "monthly": "4.6",
      "countryName": "Russian Federation",
      "country": "RU",
      "iso": "RU",
      "intl_data": "1fccd99f2f65707c290bbe4fa6ad4ad9ff0d97b1c4f2cd262eeb0538cecb64"
    }
  ]
}

Search International Number
GET`/search{?type}`

To perform this request you need to pass the did type (local,intl,toll) and country (country id returned by GET countries).

URI Parameters

HideShow

type: string (required) Example: intl
country: string (required) Example: 48e8ef9e-9da8-4584-b398-1c095b5433c4
The country code. This can be found my making a call to the GET countries route.

Purchase DID ¶

To perform this request you need to pass the did type (local,intl,toll), the two digit code for the state (GA for Georgia), the recenter for the sate, the npa and the nxx for the number.

POST https://apicontrol.call48.com/api/v4/purchase

RequestsBuy Local DID

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "type": "local",
  "numbers": [
    {
      "npa": "706",
      "nxx": "613",
      "xxxx": "4205",
      "type": "local",
      "state": "GA",
      "ratecenter": "ATHENS",
      "locData": "2d80c0952d7869653547f0",
      "loc": "1fccd99f2f65707c290bbe4fa3ad4ccbe31fd4f69ca5ce6160bc4534c4cb2b2dce08c093c3ca8b"
    }
  ]
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": true,
  "error": null
}

Purchase local numbers
POST`/purchase`

URI Parameters

HideShow

type

string (required) Example: local

numbers

array[object] (required)

npa: 706 (string) (required)
nxx: 995 (string) (required)
xxxx: 6092 (string) (required)
state: GA (string)
ratecenter: ATHENS (string)
loc: 1fccd99f2f65707c290bbe4fa2ad4ecbe31fd4f69ca5ce6160bc4534c4cb292dca08c093c3ca8b (string)
locData: 2d80c0952d7869653547f0 (string) - only required if returned in search result
fwd_trunk_grpid: 55555 (number, optional) - OD Trunk group number
fwd_preconfigured: true(boolean, optional) - Use forwarding data of account preconfigured settings

POST https://apicontrol.call48.com/api/v4/purchase

RequestsBuy Tollfree DID

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "type": "toll",
  "numbers": [
    {
      "npa": "741",
      "nxx": "852",
      "xxxx": "9632",
      "loc": "1fccd99f2f65707c290bbe4fa2ad4dcbe31fd4f69ca5ce6160bc4534c4cb292dcd08c093c3ca8b",
      "locData": "0d80c095337f797c"
    }
  ]
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": true,
  "error": null
}

Purchase tollfree numbers
POST`/purchase`

URI Parameters

HideShow

type

string (required) Example: toll

numbers

array[object] (required)

npa: 706 (string) (required)
nxx: 995 (string) (required)
xxxx: 6092 (string) (required)
loc: 1fccd99f2f65707c290bbe4fa2ad4ecbe31fd4f69ca5ce6160bc4534c4cb292dca08c093c3ca8b (string)
locData: 2d80c0952d7869653547f0 (string) - only required if returned in search result
fwd_trunk_grpid: 55555 (number, optional) - OD Trunk group number
fwd_preconfigured: true(boolean, optional) - Use forwarding data of account preconfigured settings

POST https://apicontrol.call48.com/api/v4/purchase

RequestsBuy International DID

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "type": "intl",
  "numbers": [
    {
      "id": "ae474e8a-988c-438e-b67c-3470a622cd4e",
      "name": "Arkhangelsk",
      "prefix": "8182",
      "quantity": 1,
      "loc": "1fccd99f2f65707c290bbe4fa6ad4ecef103c6a7d5f3c87436f31726d0d93b7e",
      "country": "RU"
    }
  ]
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": true,
  "error": null
}

Purchase international numbers
POST`/purchase`

URI Parameters

HideShow

type

string (required) Example: "intl"

numbers

array[object] (required)

id: “fc70c45e-5d6c-4ff6-a744-881ed2fc8095” (string) (required)
name: “Aracaju” (string, required)
prefix: “8182” (string, required)
loc: “1fccda912c743a2a724be804e6f95ed7f14191b9d2e2cf262efa0122cbc53b719f4c9581c9cabe4dc5872028f508” (string) (required)
locData: “2d80c0952d7869653547f0” (string) - only required if returned in search result
country: “BR” (string, required) - Country code
quantity: 1 (number) (required)
fwd_trunk_grpid: 55555 (number, optional) - OD Trunk group number
fwd_preconfigured: true(boolean, optional) - Use forwarding data of account preconfigured settings

Bulk Purchase local numbers ¶

POST https://apicontrol.call48.com/api/v4/lcl-did-bulk-purchase/new

Requestsexample 1

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: multipart/form-data; boundary=abcde12345
Content-Disposition: form-data; name="file"; filename="anything.csv"
Content-Type: multipart/form-data

Body

{
  "order_type": "state",
  "fwd_trunk_grpid": "52610",
  "enable_cnam_dip": "0",
  "did_tag": "simple",
  "notes": "abc"
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: multipart/form-data; boundary=abcde12345
Content-Disposition: form-data; name="file"; filename="anything.csv"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": true,
  "error": null
}

Bulk Purchase local numbers
POST`/lcl-did-bulk-purchase/new`

URI Parameters

HideShow

order_type: string (required) Example: rate_center
Possible types are state, lata, npa & rate_center
fwd_trunk_grpid: string (required) Example: 52610
Only applicable to OD Numbers, Look for ext_tgid parameter found in List trunk group API
file: file (required) Example: file upload input
this csv file will hold multiple search criteria as per the order type to fullfil this order.
enable_cnam_dip: string (optional) Example: 0
0 - false(default), 1 - true
allow_offnet: string (optional) Example: 0
0 - false(default), 1 - true - Please be advised that depending on your contract offnet numbers may have different charges then onnet. Please confirm that you want to proceed with searching both onnet and offnet for your request.
did_tag: string (optional) Example: tag value
All applicable DIDs will have this Tag attached against them
notes: string (optional) Example: use me to attach a note

List Bulk Order Requests ¶

GET https://apicontrol.call48.com/api/v4/lcl-did-bulk-purchase/list?page=1&limit=25&order_type=rate_center&status=C&order_no=OBO-4205kxw5saks8h7z7y

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": {
    "count": 6,
    "rows": [
      {
        "bulk_order_id": 15,
        "order_no": "OBO-4205kxwl2qktt133at",
        "notes": "XYZ..",
        "status": "C",
        "created_at": "2021-09-20T19:15:12.641Z",
        "order_type_id": 5,
        "did_event": "Bulk State Purchase",
        "assigned_to": "Monish_OD",
        "partition_user": null,
        "quantity": "7",
        "fulfilled_quantity": "1"
      },
      {
        "bulk_order_id": 7,
        "order_no": "OBO-4205kxwhm7kt92hkp0",
        "notes": null,
        "status": "C",
        "created_at": "2021-09-06T19:59:04.453Z",
        "order_type_id": 6,
        "did_event": "Bulk NPA Purchase",
        "assigned_to": "Monish_OD",
        "partition_user": null,
        "quantity": "5",
        "fulfilled_quantity": "2"
      }
    ]
  },
  "error": null
}

List Bulk Order Requests
GET`/lcl-did-bulk-purchase/list{?page}{&limit}{&order_type}{&status}{&order_no}`

https://apicontrol.call48.com/api/v4/lcl-did-bulk-purchase/list?page=1&limit=10&status=Q

URI Parameters

HideShow

page: string (required) Example: 1
increment by 1 to get more records, always start with 1
limit: string (optional) Example: 25
no. of records to display in single page, default is 10 & max allowed value is 50
order_type: string (optional) Example: rate_center
Filter by Order types: state, lata, npa & rate_center
status: string (optional) Example: C
Filter by Order Status: Q=Queue, E=Error, C=Complete, P=Processing
order_no: string (optional) Example: OBO-4205kxw5saks8h7z7y
Filter by Order No.

Download Bulk Order Summary Report ¶

GET https://apicontrol.call48.com/api/v4/lcl-did-bulk-purchase/summary_report/15

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: text/csv

Body

bulk_order_no,requested_quantity,fulfilled_quantity,search_lata,search_npa,search_state,search_rate_center,status
OBO-4205kxwl2qktt133at,5,1,,,AL,,C
OBO-4205kxwl2qktt133at,2,0,,,AK,,C

Download Bulk Order Summary Report
GET`/lcl-did-bulk-purchase/summary_report/{bulk_order_id}`

https://apicontrol.call48.com/api/v4/lcl-did-bulk-purchase/summary_report/15

URI Parameters

HideShow

bulk_order_id: string (required) Example: 15
append this to API endpoint as request params, this param’s value is located in bulk order listing API given above.

Download Bulk Order DID Report ¶

GET https://apicontrol.call48.com/api/v4/lcl-did-bulk-purchase/did_report/15

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: text/csv

Body

number,npa,lata,state,ratecenter
12513152371,251,480,AL,EVERGREEN

Download Bulk Order DID Report
GET`/lcl-did-bulk-purchase/did_report/{bulk_order_id}`

https://apicontrol.call48.com/api/v4/lcl-did-bulk-purchase/did_report/15

URI Parameters

HideShow

bulk_order_id: string (required) Example: 15
append this to API endpoint as request params, this param’s value is located in bulk order listing API given above.

DID ¶

GET https://apicontrol.call48.com/api/v4/dids?type=local&page=1&max=25

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": [
    {
      "_id": 147,
      "did": "2512658624",
      "number": "251-265-8624",
      "npa": "251",
      "nxx": "265",
      "xxxx": "8624",
      "fax": "false",
      "type": "local",
      "portaAID": 1343355,
      "country": null,
      "state_name": null,
      "state": null,
      "ratecenter": null,
      "rateCenter": null,
      "status": "USING",
      "isDeleted": "no",
      "assigned_id": 3,
      "portaPRID": 24230,
      "tags": "tag1,tag2",
      "rtp": "NA",
      "cnamLookup": "no",
      "cnamDisplayname": null,
      "cnamDisplaynumber": null,
      "cnamType": "",
      "e911Data": {
        "enabled": "yes",
        "country": "US",
        "state": "FL",
        "zipcode": "33155",
        "businessname": "test user",
        "address": "Apartment 2",
        "streetname": "Test St",
        "streetnumber": "123"
      },
      "faxData": {
        "servive": "",
        "email": null,
        "serial": null,
        "guid": null
      },
      "listing411Data": {
        "enabled": "no",
        "type": "RES",
        "country": "US",
        "state": null,
        "zip": null,
        "lstgn": null,
        "lstnm": null,
        "business": null,
        "locnm": null,
        "strt": null
      },
      "forwardingData": {
        "method1": "simple",
        "method2": "ip",
        "method3": "simple",
        "timeout1": "99",
        "timeout2": "20",
        "timeout3": "60",
        "sip1": "",
        "sip2": "127.0.0.1",
        "sip3": "",
        "number1": "2522378144",
        "number2": "",
        "number3": "2223331234",
        "password": "secret123",
        "fwd_trunk_grpid": 52610,
        "sipdigits": "NA",
        "answeringmode": 2,
        "sequence": "",
        "product": 24230
      }
    }
  ],
  "code": 200
}

Get DID
GET`/dids{?type}{&page}{&max}`

https://apicontrol.call48.com/api/v4/dids?type=local&page=1&max=10

URI Parameters

HideShow

type: string (required) Example: local
possible input values are local, toll & intl
page: string (required) Example: 1
always start with 1
max: string (required) Example: 25

DELETE https://apicontrol.call48.com/api/v4/dids

Requestswith IDswith Numbers

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "id": [
    174
  ]
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": {
    "success": true
  },
  "error": null
}

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "numbers": [
    "2702496110"
  ]
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": {
    "success": true
  },
  "error": null
}

Remove DID
DELETE`/dids`

URI Parameters

HideShow

id: array (required) Example: [179]
DID IDs found in Get DID API in parameter “_id”. Only required if not using “numbers” property.
numbers: array (required) Example: ["2702496110"]
In case of US numbers dont include prefix code 1. only required if not using “id” property.

411 ¶

GET https://apicontrol.call48.com/api/v4/update411?number=2512658624&enabled=yes&type=RES&country=US&state=FL&lstgn=test&lstnm=test&strt=123&locnm=Miami&zip=33155

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/2000json

Body

{
  "error": null,
  "data": true,
  "code": 200
}

Update 411
GET`/update411{?number}{&enabled}{&type}{&country}{&state}{&lstgn}{&lstnm}{&strt}{&locnm}{&zip}`

https://apicontrol.call48.com/api/v4/update411?number=2512658624&enabled=yes&type=RES&country=US&state=FL&lstgn=test&lstnm=test&strt=123&locnm=Miami&zip=33155

URI Parameters

HideShow

number: string (required) Example: 2512658624
enabled: string (required) Example: yes
type: string (required) Example: RES
country: string (required) Example: US
state: string (required) Example: FL
lstgn: string (required) Example: test
lstnm: string (required) Example: test
strt: string (required) Example: 123
locnm: string (required) Example: Miami
zip: string (required) Example: 33155

911 ¶

GET https://apicontrol.call48.com/api/v4/update911?number=2512658624&enabled=yes&country=US&state=FL&streetnumber=123&streetname=Test&city=Miami&zipcode=33155&addresstypenumber=Apartment

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": "20312026",
  "code": 200
}

Update 911
GET`/update911{?number}{&enabled}{&country}{&state}{&streetnumber}{&streetname}{&city}{&zipcode}{&addresstypenumber}`

https://apicontrol.call48.com/api/v4/update911?number=2512658624&enabled=yes&country=US&state=FL&name=test%20user&streetnumber=123&streetname=Test%20St&city=Miami&addresstypenumber=Apartment%202&zipcode=33155

URI Parameters

HideShow

number: string (required) Example: 2512658624
enabled: string (required) Example: yes
country: string (required) Example: US
state: string (required) Example: FL
name: string (required) Example: test
streetnumber: string (required) Example: 123
streetname: string (required) Example: Test
city: string (required) Example: Miami
addresstypenumber: string (required) Example: Apartment
zipcode: string (required) Example: 33155

TAGS ¶

GET https://apicontrol.call48.com/api/v4/update_tags?number=2512658624&tags=tag1,tag2

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": true,
  "code": 200
}

Update Tags
GET`/update_tags{?number}{&tags}`

https://apicontrol.call48.com/api/v4/update_tags?number=2512658624&tags=tag1,tag2

URI Parameters

HideShow

number: string (required) Example: 2512658624
tags: string (required) Example: tag1,tag2

Fax ¶

POST https://apicontrol.call48.com/api/v4/update_fax

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
error: null,
data: "1234567"
}

Update Fax
POST`/update_fax`

URI Parameters

HideShow

number: string (required) Example: 7069956092
In case of US Numbers, don’t include the Country Code “1”
service: number (required) Example: 0
0 - disable, 1 - Inbound Only, 2 - In and Outbound, 3 - Fax ATA
email: string (required) Example: test@email.com
serial: string (required) Example: 123454
Required If service is 3 - Fax ATA

Forwarding ¶

POST https://apicontrol.call48.com/api/v4/update_forwarding

RequestsForward to Number/IP/NumberRegister Device/TrunkForward to OD TG

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "number": "2512658624",
  "sequence": "Simultaneous",
  "answeringmode": "2",
  "method1": "simple",
  "number1": "2522378144",
  "timeout1": "99",
  "sipdigits": "11",
  "method2": "ip",
  "sip2": "127.0.0.1",
  "timeout2": "20",
  "method3": "simple",
  "number3": "2223331234",
  "timeout3": "60"
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

For OD
{
"error": null,
"data":  [
  {
  "description": "Routing request completed"
  }
],
"code": 200
}
For Porta
{
"error": null,
"data": {
  "login": "12512658624",
  "i_product": "24230",
  "i_account": 1343355
},
"code": 200
}

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "number": "2512658624",
  "answeringmode": "2",
  "method1": "trunk",
  "username": "12512658624",
  "password": "secret123",
  "timeout1": "30",
  "product": "24230"
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

For OD
{
"error": null,
"data":  [
  {
  "description": "Routing request completed"
  }
],
"code": 200
}
For Porta
{
"error": null,
"data": {
  "login": "12512658624",
  "i_product": "24230",
  "i_account": 1343355
},
"code": 200
}

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "number": "8881234560",
  "fwd_trunk_grpid": 52610
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

For OD
{
"error": null,
"data":  [
  {
  "description": "Routing request completed"
  }
],
"code": 200
}
For Porta
{
"error": null,
"data": {
  "login": "12512658624",
  "i_product": "24230",
  "i_account": 1343355
},
"code": 200
}

Update Forwarding
POST`/update_forwarding`

URI Parameters

HideShow

number: String (required) Example: 8881245555
Number to be updated
sequence: string (required) Example: Order
Order, Simultaneous, Random
product: string (required) Example: 6789
i_product value, auto selection of product enabled in case of wholesale customer.
answeringmode: string (required) Example: 3
0 - Reject, 1 - Ring Only, 2 - Forward Only, 3 - Ring Then Forward, 4 - Voicemail Only, 5 - Ring Then Voicemail, 6 - Forward, Voicemail, 7 - Ring, Forward, Voicemail
method1: string (required) Example: preconfigured
“” - None, “preconfigured” - Preconfigured Setting, “simple” - Forward to Local Number, “ip” - Forward to IP address/PBX, “trunk” - Register Device/Trunk
number1: string (required) Example: 1234567890
if method1 is simple
timeout1: string (required) Example: 20
if method1 is not preconfigured, value in seconds
sipdigits: string (required) Example: 11
11, 10
username: string (required) Example: testuser
if method1 is trunk
password: string (required) Example: tetstuser password
sip1: string (required) Example: 127.0.0.1
if method1 is ip, forward to IP address
method2: string (required) Example: simple
number2: string (required) Example: 1234567890
if method2 is simple
timeout2: string (required) Example: 20
if method2 is not preconfigured, value in seconds
sip2: string (required) Example: 127.0.0.1
if method2 is ip, forward to IP address
method3: string (required) Example: simple
number3: string (required) Example: 1234567890
if method3 is simple
timeout3: string (required) Example: 20
if method3 is not preconfigured, value in seconds
sip3: string (required) Example: 127.0.0.1
if method3 is ip, forward to IP address
fwd_trunk_grpid: number (required) Example: 52610
Only applicable to OD Numbers, Look for ext_tgid parameter found in List trunk group API

Did Create Cnam ¶

POST https://apicontrol.call48.com/api/v4/did/create-cnam

RequestsCreate Did Cnam

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "cnam_status": true,
  "cnam_type": "RES",
  "display_name": "testcnam 12362320049",",
  "display_number": 12362320049,
  "did_id": 44978,
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body


{
"error": null,
"data": {
  "did_cnam_id": "6720",
  "did_id": "44978",
  "cnam_status": true
  "cnam_type": RES
  "display_name": testcnam 12362320049
  "display_number": 12362320049
  "is_billed": true
  "invoice_id": 733
  "is_active": true
  "created_at": 2024-12-09T08:13:52.512Z
  "updated_at": 2024-12-09T08:13:52.512Z
},
"code": 200
"message": Successful Operation
}

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

Responses200

Headers

Create Did Cnam
POST`/did/create-cnam`

URI Parameters

HideShow

cnam_status: boolean Example: true
true, false
cnam_type: string Example: RES
RES,BIZ
display_name: string Example: testcnam 12362320049
Display name
display_number: string Example: 12362320049
Display Number
did_id: string Example: 44978
Did id

OD Trunk Group ¶

Create trunk group ¶

POST https://apicontrol.call48.com/api/v4/trunkgrp/create

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Trunk Group created successfully",
  "data": {
    "ss_verify": false,
    "trunk_grpid": 20,
    "trunk_name": "TG NAME",
    "route_type": "RR",
    "num_format": "e164",
    "cli_type": "paid",
    "prefix": "2377#",
    "trunk_ips": [
      {
        "port": 5060,
        "trunk_grpid": 20,
        "ip_address": "10.50.250.11"
      },
      {
        "port": 5060,
        "trunk_grpid": 20,
        "ip_address": "10.50.250.15"
      }
    ],
    "account_id": 15,
    "ext_tgid": 52620,
    "od_custid": 10031,
    "order_no": "newTG-4205kxwnpfkou3dzco",
    "ext_tgstatus": "queued",
    "updated_at": "2021-05-18T13:48:55.633Z",
    "created_at": "2021-05-18T13:48:55.633Z"
  },
  "error": null
}

Create trunk group
POST`/trunkgrp/create`

URI Parameters

HideShow

trunk_name

string (required) Example: "TG NAME"

route_type

string (optional) Example: "RR"

RR - RoundRobin(default), TD - TopDown

num_format

string (optional) Example: "e164"

e164(default), 11, 10

cli_type

string (optional) Example: "paid"

paid(default), rpid

prefix

string (optional) Example: "2377#"

trunk_ips

array[object] (required)

ip_address: “10.50.250.10” (string, required) - valid ip address, with or without port number.

Update trunk group ¶

PUT https://apicontrol.call48.com/api/v4/trunkgrp/update

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Success",
  "data": null,
  "error": null
}

Update trunk group
PUT`/trunkgrp/update`

URI Parameters

HideShow

trunk_grpid

number (required) Example: 10

unique identifier which would be present in listing request of trunk group

trunk_name

string (optional) Example: "TG UPDATE"

route_type

string (optional) Example: "TD"

RR - RoundRobin(default), TD - TopDown

num_format

string (optional) Example: "11"

e164(default), 11, 10

cli_type

string (optional) Example: "paid"

paid(default), rpid

prefix

string (optional) Example: "7777#"

deleted_ips

array (optional) Example: ["10.50.250.12:5060", "10.50.250.77"]

Specify the IPs(with/without port) to remove

trunk_ips

array[object] (required)

New IPs to add

ip_address: “10.50.250.10” (string, required) - valid ip address, with or without port number.

List trunk group ¶

GET https://apicontrol.call48.com/api/v4/trunkgrp/list?limit=5

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
"code": 200,
"message": "Success",
"data": {
"result": [
  {
    "trunk_grpid": 11,
    "ext_tgid": 52610, // Use this params value in fwd_trunk_grpid while routing numbers to a specific trunk group 
    "trunk_name": "Call48 Test",
    "account_id": 3,
    "route_type": "TD",
    "num_format": "11",
    "cli_type": "paid",
    "prefix": null,
    "ss_verify": false,
    "trunk_ips": [
      "10.50.250.10:5060"
    ],
    "account_username": "monish_whs"
  }
],
"totalRecords": "1",
"enableNext": false
},
"error": null
}

List trunk group
GET`/trunkgrp/list{?limit}`

URI Parameters

HideShow

limit: number (required) Example: 5

Resources ¶

Get Countries ¶

GET https://apicontrol.call48.com/api/v4/countries

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
code: 200,
error: null,
totalRecords: 227,
data:[
{
  "country_id": 225,
  "name": "United States",
  "code": "US",
  "code2": "USA",
  "prefix": "1",
  "req": ""
},
{
  "country_id": 6,
  "name": "Afghanistan",
  "code": "AF",
  "code2": "AFG",
  "prefix": "93",
  "req": ""
},
]
}

Get Countries
GET`/countries`

Include only Authorization header for this request

Get States ¶

GET https://apicontrol.call48.com/api/v4/states

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
error: null,
data:[
{
  "state_id": 1,
  "state_name": "Alabama",
  "state_code": "AL",
  "country_id": 225
},
{
  "state_id": 2,
  "state_name": "Alaska",
  "state_code": "AK",
  "country_id": 225
}
]
}

Get States
GET`/states`

Include only Authorization header for this request

Get Rate Center List By State ¶

GET https://apicontrol.call48.com/api/v4/ratecenter?state="FL"

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
code: 200,
error: null,
data:[
{
  "footprint_id": 1,
  "rate_center": "ABBEVILLE"
},
{
  "footprint_id": 2,
  "rate_center": "ABBEVILLE"
},
{
  "footprint_id": 3,
  "rate_center": "ABBEVILLE"
}
]
}

Get Rate Center List By State
GET`/ratecenter{?state}`

This API is used to view state details.

URI Parameters

HideShow

state: string (required) Example: "FL"
state 2 char code

Address ¶

GET https://apicontrol.call48.com/api/v4/verifyaddress?country=US&state=MA&name=E911TEST&streetnumber=777&streetname=Brockton Avenue&city=Abington&zipcode=02351&location=Boca Raton

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": true,
  "code": 200
}

Verify Address
GET`/verifyaddress{?country}{&state}{&name}{&streetnumber}{&streetname}{&city}{&zipcode}{&location}`

URI Parameters

HideShow

country: string (required) Example: US
state: string (required) Example: MA
name: string (required) Example: E911TEST
streetnumber: string (required) Example: 777
streetname: string (required) Example: Brockton Avenue
city: string (required) Example: Abington
zipcode: string (required) Example: 02351
location: string (optional) Example: Boca Raton

Account ¶

POST https://apicontrol.call48.com/api/v4/signup

Requestsexample 1

Headers

Content-Type: application/json

Responses200

Headers

Content-Type: application/json

Body

{
  "error": null,
  "data": "true"
}

Create Account
POST`/signup`

URI Parameters

HideShow

firstname: string (required) Example: test
lastname: string (required) Example: user
company: string (required) Example: sample1
address: string (required) Example: Brooklyn street
city: string (required) Example: Brooklyn
country: string (required) Example: US
state: string (required) Example: FL
username: string (required) Example: testuser
password: string (required) Example: tetstuser password
confirmpassword: string (required) Example: tetstuser password
email: string (required) Example: user@sample.com
phone: string (required) Example: 5555555555
terms: number (required) Example: 1

Payment ¶

GET https://apicontrol.call48.com/api/v4/payment?amount=40.00

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": "true"
}

Make Payment
GET`/payment{?amount}`

URI Parameters

HideShow

amount: string (required) Example: 40.00
Amount being payed. (Must be greater than $20.00)

Customers ¶

GET https://apicontrol.call48.com/api/v4/customers

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
error: null,
total: 2,
data: [
{
  "account_id": 24,
  "i_customer": 24,
  "login": "friday_night_lights",
  "phone1": "7757575757",
  "email": "friday_night@lights.com",
  "firstname": "friday night",
  "lastname": "lights",
  "is_active": true,
  "salutation": "Company",
  "iso_4217": "USD",
  "companyname": "MK_PP",
  "city": null,
  "status": "approved",
  "state": null,
  "country": null,
  "jerasoft_id": 1035,
  "porta_cid": 64735,
  "credit_limit": "500.00000",
  "credit_limit_warning": "100.00000",
  "account_pid": 11,
  "porta_class_id": 2348,
  "zip": null,
  "creation_date": "2021-04-30T20:00:41.298Z",
  "blocked": "N",
  "baddr1": null,
  "baddr2": null,
  "i_customer_type": 1,
  "bcc": "abc@gmail.com"
},
{
  "account_id": 23,
  "i_customer": 23,
  "login": "reg_user_test",
  "phone1": "7766776677",
  "email": "register@user.com",
  "firstname": "register",
  "lastname": "user",
  "is_active": true,
  "salutation": "Company",
  "iso_4217": "USD",
  "companyname": "MK_PP",
  "city": null,
  "status": "approved",
  "state": null,
  "country": null,
  "jerasoft_id": 1034,
  "porta_cid": 64734,
  "credit_limit": "500.00000",
  "credit_limit_warning": "300.00000",
  "account_pid": 11,
  "porta_class_id": 2348,
  "zip": null,
  "creation_date": "2021-04-30T19:50:32.667Z",
  "blocked": "N",
  "baddr1": null,
  "baddr2": null,
  "i_customer_type": 1,
  "bcc": "abc@gmail.com"
}
]
}

Get Customers
GET`/customers`

PUT https://apicontrol.call48.com/api/v4/customers

Requests- Sample

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "portaClass": 2348,
  "username": "devsub1247",
  "creditLimit": 50,
  "creditLimitWarning": 20,
  "email": "test@gmail.com",
  "password": "123456",
  "salutation": "Mr.",
  "firstname": "test",
  "lastname": "Sub1247",
  "address": "1767 Hermitage Blvd",
  "address2": "Apt B1",
  "zip": "02501",
  "city": "brb",
  "state": "NY",
  "country": "US",
  "companyname": "DEV Sub",
  "portaCurrency": "USD",
  "portaBcc": "mohnish.kataria@brainvire.com,mohnish7495@gmail.com",
  "phone": "918828381123"
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
error: null,
data: true,
code: 200
}

Create Customer
PUT`/customers`

URI Parameters

HideShow

portaClass: number (required) Example: 905
username: string (required) Example: yung
this has to be unique
creditLimit: number (required) Example: 23
creditLimitWarning: number (required) Example: 40
email: string (required) Example: test@gmail.com
password: string (required) Example: testpass
salutation: string (required) Example: Mr.
firstname: string (required) Example: test
lastname: string (required) Example: user
address: string (required) Example: 1767 Hermitage Blvd
address2: string (optional) Example: Apt B1
city: string (required) Example: brb
zip: string (required) Example: 32308
country: string (required) Example: US
companyname: string (optional) Example: test
if not included, this customer’s company name would be as per reseller’s company name.
portaCurrency: string (required) Example: USD
portaBcc: string (required) Example: test1@gmail.com,test2@mail.com

Simultaneous Calls ¶

PUT https://apicontrol.call48.com/api/v4/limitsimulcalls

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": {
    "i_customer": 63766
  }
}

Set Customer Simultaneous Calls
PUT`/limitsimulcalls`

URI Parameters

HideShow

id: number (required) Example: 131
Account Id of the customer
limitsimulcalls: string (required) Example: yes/no
yes for Enabled or no for Disabled
simulmaxcallsin: number (required) Example: 3
simulmaxcallsout: number (required) Example: 2
simulmaxcalls: number (required) Example: 4

Call parking ¶

POST https://apicontrol.call48.com/api/v4/callparking

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": {
    "i_customer": 63766
  }
}

Update Customer Call Parking
POST`/callparking`

Discount Plan ¶

GET https://apicontrol.call48.com/api/v4/discountplan

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": [
    {
      "is_used": 1,
      "reset_period": "Billing-period",
      "dest_group_set_name": "US-Canada",
      "iso_4217": "USD",
      "managed_by": null,
      "name": "1000 Free Minutes",
      "description": "1500 Free Minutes for Business Plan",
      "destination_lookup": "N",
      "i_dest_group_set": 6,
      "shared": "Y",
      "i_customer": null,
      "i_vd_plan": 18
    },
    {
      "is_used": 1,
      "reset_period": "Billing-period",
      "dest_group_set_name": "US-Canada",
      "iso_4217": "USD",
      "managed_by": null,
      "name": "1500 Free Minutes",
      "description": "1500 Free Minutes for Business Basic Plan",
      "destination_lookup": "N",
      "i_dest_group_set": 6,
      "shared": "Y",
      "i_customer": null,
      "i_vd_plan": 4
    }
  ]
}

Get Discount Plans
GET`/discountplan`

POST https://apicontrol.call48.com/api/v4/discountplan

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": {
    "i_customer": 63766
  }
}

Add Discount Plan
POST`/discountplan`

URI Parameters

HideShow

id: number (required) Example: 131
i_vd_plan: number (required) Example: 18

RTP ¶

POST https://apicontrol.call48.com/api/v4/rtp

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": {
    "i_customer": 63766
  }
}

Set RTP
POST`/rtp`

URI Parameters

HideShow

id: number (required) Example: '131'
Account Id of the customer.
rtp: string (required) Example: 1
Default - N, Direct - 0, Optimal - 1, On Nat - 2, Always - 3

Paging ¶

POST https://apicontrol.call48.com/api/v4/paging

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": {
    "i_customer": 55826
  }
}

Set Customer Paging
POST`/paging`

URI Parameters

HideShow

id: number (required) Example: 131
Account Id of the customer.
paging: string (required) Example: yes
No, Yes

Subscriptions ¶

GET https://apicontrol.call48.com/api/v4/subscriptions?id=199

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": [
    {
      "subscription_id": 23,
      "i_subscription": 3490,
      "i_customer_subscription": 6479,
      "name": "MK RSLR T2 7",
      "discount_rate": 0,
      "assigned_id": 199,
      "created_by": 192,
      "iso_4217": "USD",
      "start_date": "2021-02-09",
      "finish_date": "2021-02-10",
      "mongo_id": null,
      "mongo_uid": null,
      "mongo_cid": null,
      "status": "close",
      "pending_msg": null,
      "created_at": "2021-02-09T15:52:12.364Z",
      "updated_at": "2021-02-10T09:50:24.232Z",
      "activation_date": "2021-02-09",
      "int_status": 2,
      "generate_daily_charge": "N",
      "effective_fee": 7,
      "discount_list": [],
      "next_effective_fee": 7,
      "billed_to": "2021-02-10",
      "has_discount": 0,
      "is_finished": "Y",
      "invoice_description": "MK RSLR T2",
      "rounding": 2,
      "i_customer": 64002
    },
    {
      "subscription_id": 23,
      "i_subscription": 3490,
      "i_customer_subscription": 6479,
      "name": "MK RSLR T2 7",
      "discount_rate": 0,
      "assigned_id": 199,
      "created_by": 192,
      "iso_4217": "USD",
      "start_date": "2021-02-09",
      "finish_date": "2021-02-10",
      "mongo_id": null,
      "mongo_uid": null,
      "mongo_cid": null,
      "status": "close",
      "pending_msg": null,
      "created_at": "2021-02-09T15:52:12.364Z",
      "updated_at": "2021-02-10T09:50:24.232Z",
      "activation_date": "2021-02-09",
      "int_status": 2,
      "generate_daily_charge": "N",
      "effective_fee": 7,
      "discount_list": [],
      "next_effective_fee": 7,
      "billed_to": "2021-02-10",
      "has_discount": 0,
      "is_finished": "Y",
      "invoice_description": "MK RSLR T2",
      "rounding": 2,
      "i_customer": 64002
    }
  ]
}

Get Subscriptions
GET`/subscriptions{?id}`

URI Parameters

HideShow

id: number (required) Example: 199
this will be the account id which you will get from Get Customers API

XDR ¶

GET https://apicontrol.call48.com/api/v4/xdr?from="2021&to="2021&page=1&max=10&customer=tollfree

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "error": null,
  "data": {
    "xdr_list": [
      {
        "destination": "1352",
        "i_dest": 116015,
        "CLD": "18002823655",
        "i_xdr": 433758673,
        "i_account": 395961,
        "connect_time": "2019-03-31 21:48:15",
        "charged_amount": 0.00417,
        "bit_flags": 8,
        "unix_connect_time": 1554068895,
        "history": "+3x6@0.0139",
        "xdr_type": "account",
        "bill_status": "O",
        "call_id": "8568443f-cea1-1237-a0bf-005056a967c8",
        "service": "Voice Calls",
        "description": "Florida",
        "account_id": "18002823655",
        "aux_xdrs": [
          {
            "value": "0",
            "xdr_time": "2019-03-31 21:48:30",
            "xdr_column_id": "media_duration"
          }
        ],
        "setup_time": 137,
        "h323_conf_id": "E5029AF0 07FE359A B14D8F9A 26CFB66E",
        "disconnect_time": "2019-03-31 21:48:30",
        "disconnect_reason": "Normal call clearing",
        "i_service": 3,
        "subdivision": "",
        "iso_3166_1_a3": "USA",
        "CLI": "13523076475",
        "bill_time": "2019-03-31 21:48:15",
        "i_rate": 184426612,
        "is_split": "0",
        "country": "United States of America",
        "unix_disconnect_time": 1554068910,
        "charged_quantity": 18,
        "disconnect_cause": "16",
        "i_customer": 55694,
        "formatted_bill_time": "00:00:15"
      },
      {
        "destination": "VOICEONNETR",
        "i_dest": 476312,
        "CLD": "18002823655",
        "i_xdr": 433758672,
        "i_account": 395961,
        "connect_time": "2019-03-31 21:48:15",
        "charged_amount": 0,
        "bit_flags": 12,
        "unix_connect_time": 1554068895,
        "history": "+15x1@0.0",
        "xdr_type": "account",
        "bill_status": "O",
        "call_id": "8568443f-cea1-1237-a0bf-005056a967c8",
        "service": "Voice Calls",
        "description": "ON-NET CALLING",
        "account_id": "18002823655",
        "h323_incoming_conf_id": "E5029AF0 07FE359A B14D8F9A 26CFB66E",
        "aux_xdrs": [
          {
            "value": "0",
            "xdr_time": "2019-03-31 21:48:30",
            "xdr_column_id": "media_duration"
          }
        ],
        "setup_time": 136,
        "h323_conf_id": "D3DB8EA5 8B2F79B6 0849F854 0849F854",
        "disconnect_time": "2019-03-31 21:48:30",
        "disconnect_reason": "Normal call clearing",
        "i_service": 3,
        "subdivision": "",
        "iso_3166_1_a3": "---",
        "CLI": "13523076475",
        "bill_time": "2019-03-31 21:48:15",
        "i_rate": 272800724,
        "is_split": "0",
        "country": "",
        "unix_disconnect_time": 1554068910,
        "disconnect_cause": "16",
        "charged_quantity": 15,
        "i_customer": 55694,
        "formatted_bill_time": "00:00:15"
      }
    ],
    "total": 2391
  }
}

Get XDRs
GET`/xdr{?from}{&to}{&page}{&max}{&customer}`

URI Parameters

HideShow

from: string (required) Example: "2021
04-01 00:00" (string, required) - The start date range for the call data records.
to: string (required) Example: "2021
04-01 23:59" (string, required) - The end date range for the call data records.
customer: string (required) Example: tollfree
Customer can be local, tollfree, international, termination or holding. if this param is not provided then considering all.
page: number (required) Example: 1
The page of the data that to be shown. Start from 1.
max: number (required) Example: 10
The amount of data to be displayed on on page.

Port ¶

CHECK PORT ¶

POST https://apicontrol.call48.com/api/v4/port-in/check-ports

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Number(s) can be ported",
  "data": {
    "7012001293": true
  }
}

Check Portability
POST`/port-in/check-ports`

URI Parameters

HideShow

did_type: string (required) Example: "LCL"
numbers: array (required) Example: ["17012001293"]

SUBMIT PORT DETAILS ¶

POST https://apicontrol.call48.com/api/v4/port-in/submit-port-details

Requests- Sample

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"*
Content-Type: application/json

Body

{
  "did_type": "LCL",
  "port_req_detail": {
    "cust_acc_name": "Test 1324",
    "cust_authorized_name": "Test user",
    "cust_acc_type": "RES",
    "address_street_name": "Test",
    "address_number": "54322",
    "address_loc_designator": "Test",
    "city": "Test",
    "btn": "43020",
    "state": "AL",
    "activation_type": "Auto",
    "desired_foc_date": "2022-06-03T00:00:00Z",
    "postal_code": "532132",
    "activation_date": "2022-06-03T12:00:00-04:00"
  },
  "numbers": [
    "2003970129"
  ]
}

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"*
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": {
    "port_req_id": 256
  }
}

Submit Port Request
POST`/port-in/submit-port-details`

URI Parameters

HideShow

did_type

string (required) Example: "LCL"

account_id

number (optional) Example: 712

for assigning port to internal customer

numbers

array (required) Example: ["7012006921"]

port_req_detail

object (required)

cust_acc_name: “test 1232” (string, required)
cust_authorized_name: “test” (string, required)
cust_acc_type: “RES”, (string, required) - Value : ‘RES’, ‘BIZ’
cust_acc_number: 1234566 (string, required)
cust_acc_pin: 123 (string, optional)
activation_type: “Auto” (string, required), Default : ‘Auto’, Other: ‘Manual’, ‘Scheduled’
address_direction_prefix: “test” (string, optional)
address_direction_suffix: “test” (string, optional)
address_street_name_suffix: “test” (string, optional)
address_street_name: “test” (string, required)
address_number: “test” (string, required)
address_loc_value: “test” (string, optional)
address_loc_designator: “test” (string, required)
city: “test” (string, required)
postal_code: “1234e” (string, required)
desired_foc_date: “2022-05-02T00:00:00Z” (date, required) - UTC date format
btn: 64221 (string, required)
state: “MI”, (string, required)
activation_date: “2022-05-02T12:00:00-04:00” (date, required) - EST date format
email_updates: "test.user@example.com" (string, optional)
fwd_preconfigured: false (boolean, optional)
fwd_trunk_grpid: 123 (number, optional)
fwd_sip_type: ‘NA’ (string, required)- DEFAULT - NA, Other - ‘11’, ‘10’, ‘E164’, ‘INTL’, ‘OPEN’
fwd_order: ‘NA’ (string, required)- Default - NA , Other - ‘ALS’, ‘SIML’, ‘RND’
fwd_answering_mode: ‘NA’ (string, required) - Default - NA , Other - ‘REJ’, ‘RO’, ‘FO’, ‘RTF’, ‘VO’, ‘RTV’, ‘FV’, ‘RFV’
fwd_device_password: ‘23211’ (string, optional)
notes: ‘testing’ (string, optional)
tags: “t1 , t2” (string, optional)

VIEW PORT DETAIL ¶

GET https://apicontrol.call48.com/api/v4/port-in/view-port-detail?port_req_id=12&port_proposal_id=123

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "data": {
    "port_req_id": 12,
    "did_type_id": 1,
    "account_id": 712,
    "csv_file": false,
    "port_proposal_id": 123,
    "port_req_detail_id": 136,
    "cust_acc_name": "Test",
    "cust_acc_type": "RES",
    "cust_acc_number": null,
    "cust_acc_pin": null,
    "cust_authorized_name": "Test",
    "btn": "5422",
    "desired_foc_date": "2022-03-02T05:00:00.000Z",
    "address_direction_prefix": null,
    "address_direction_suffix": null,
    "address_street_name_suffix": null,
    "address_street_name": "Test",
    "address_number": "64332",
    "address_loc_designator": "Test",
    "address_loc_value": null,
    "postal_code": null,
    "city": "Test",
    "state_id": 25,
    "loa_file": null,
    "bill_file": null,
    "csr_file": null,
    "activation_type": "Auto",
    "activation_date": "2022-03-02T00:00:00.000Z",
    "email_updates": null,
    "notes": null,
    "state_name": "Michigan",
    "state_code": "MI",
    "tags": "t1 , t2"
  }
}

Fetch Port Detail
GET`/port-in/view-port-detail{?port_req_id}{&port_proposal_id}`

URI Parameters

HideShow

port_req_id: Number (optional) Example: 12
Required only when need to fetch master port detail
port_proposal_id: Number (optional) Example: 123
Required only when need to fetch sub order detail

VIEW LIST ¶

POST https://apicontrol.call48.com/api/v4/port-in/view-list

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
"code": 200,
"data": {
"result": [
  {
    "port_req_id": 256,
    "did_type_id": 1,
    "import_from_file": null,
    "request_phase": "In_Progress",
    "suborder_count": 1,
    "created_at": "2022-01-31T06:10:41.967Z",
    "did_type_name": "Local",
    "account_id": 712,
    "account_username": "test.user",
    "account_class_id": 1,
    "csv_file": false,
    "port_proposals": [
      {
        "port_proposal_id": 201,
        "port_req_status": "submitted",
        "resubmitted_at": null,
        "did_count": 1,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": true,
        "allow_suborder_cancel": true,
        "allow_suborder_delete": false,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 254,
    "did_type_id": 1,
    "import_from_file": null,
    "request_phase": "Cancelled",
    "suborder_count": 1,
    "created_at": "2022-01-25T14:28:42.639Z",
    "did_type_name": "Local",
    "account_id": 712,
    "account_username": "test.user",
    "account_class_id": 1,
    "csv_file": false,
    "port_proposals": [
      {
        "port_proposal_id": 199,
        "port_req_status": "cancelled",
        "resubmitted_at": null,
        "did_count": 1,
        "foc_date": null,
        "failure_reason": "No DID found for build operation!",
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": true,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 253,
    "did_type_id": 1,
    "import_from_file": null,
    "request_phase": "In_Progress",
    "suborder_count": 1,
    "created_at": "2022-01-25T14:26:07.852Z",
    "did_type_name": "Local",
    "account_id": 712,
    "account_username": "test.user",
    "account_class_id": 1,
    "csv_file": false,
    "port_proposals": [
      {
        "port_proposal_id": 198,
        "port_req_status": "reviewed",
        "resubmitted_at": null,
        "did_count": 1,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": false,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 252,
    "did_type_id": 1,
    "import_from_file": null,
    "request_phase": "Cancelled",
    "suborder_count": 1,
    "created_at": "2022-01-25T13:00:27.185Z",
    "did_type_name": "Local",
    "account_id": 712,
    "account_username": "test.user",
    "account_class_id": 1,
    "csv_file": false,
    "port_proposals": [
      {
        "port_proposal_id": 197,
        "port_req_status": "cancelled",
        "resubmitted_at": "2022-01-25T13:21:37.029Z",
        "did_count": 1,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": true,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 251,
    "did_type_id": 1,
    "import_from_file": null,
    "request_phase": "In_Progress",
    "suborder_count": 1,
    "created_at": "2022-01-25T07:12:28.539Z",
    "did_type_name": "Local",
    "account_id": 713,
    "account_username": "test_sub_cust",
    "account_class_id": 1,
    "csv_file": false,
    "port_proposals": [
      {
        "port_proposal_id": 196,
        "port_req_status": "reviewed",
        "resubmitted_at": null,
        "did_count": 1,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": false,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 250,
    "did_type_id": 1,
    "import_from_file": null,
    "request_phase": "In_Progress",
    "suborder_count": 1,
    "created_at": "2022-01-25T07:09:19.392Z",
    "did_type_name": "Local",
    "account_id": 713,
    "account_username": "test_sub_cust",
    "account_class_id": 1,
    "csv_file": false,
    "port_proposals": [
      {
        "port_proposal_id": 195,
        "port_req_status": "reviewed",
        "resubmitted_at": null,
        "did_count": 1,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": false,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 249,
    "did_type_id": 1,
    "import_from_file": null,
    "request_phase": "Cancelled",
    "suborder_count": 1,
    "created_at": "2022-01-25T07:02:53.322Z",
    "did_type_name": "Local",
    "account_id": 713,
    "account_username": "test_sub_cust",
    "account_class_id": 1,
    "csv_file": false,
    "port_proposals": [
      {
        "port_proposal_id": 194,
        "port_req_status": "cancelled",
        "resubmitted_at": null,
        "did_count": 1,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": true,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 248,
    "did_type_id": 1,
    "import_from_file": "call48_1643028432234_eVq8qArIQO.csv",
    "request_phase": "In_Progress",
    "suborder_count": 2,
    "created_at": "2022-01-24T12:47:22.448Z",
    "did_type_name": "Local",
    "account_id": 712,
    "account_username": "test.user",
    "account_class_id": 1,
    "csv_file": true,
    "port_proposals": [
      {
        "port_proposal_id": 192,
        "port_req_status": "cancelled",
        "resubmitted_at": null,
        "did_count": 12,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": true,
        "allow_suborder_activate": false,
        "is_master": true
      },
      {
        "port_proposal_id": 193,
        "port_req_status": "cancelled",
        "resubmitted_at": null,
        "did_count": 6,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": true,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 247,
    "did_type_id": 1,
    "import_from_file": null,
    "request_phase": "In_Progress",
    "suborder_count": 1,
    "created_at": "2022-01-24T12:31:34.566Z",
    "did_type_name": "Local",
    "account_id": 713,
    "account_username": "test_sub_cust",
    "account_class_id": 1,
    "csv_file": false,
    "port_proposals": [
      {
        "port_proposal_id": 191,
        "port_req_status": "cancelled",
        "resubmitted_at": null,
        "did_count": 1,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": true,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  },
  {
    "port_req_id": 245,
    "did_type_id": 1,
    "import_from_file": "call48_1643019307386_zvqCsfD8Tw.csv",
    "request_phase": "In_Progress",
    "suborder_count": 4,
    "created_at": "2022-01-24T10:15:12.503Z",
    "did_type_name": "Local",
    "account_id": 712,
    "account_username": "test.user",
    "account_class_id": 1,
    "csv_file": true,
    "port_proposals": [
      {
        "port_proposal_id": 188,
        "port_req_status": "cancelled",
        "resubmitted_at": null,
        "did_count": 2,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": true,
        "allow_suborder_activate": false,
        "is_master": true
      },
      {
        "port_proposal_id": 187,
        "port_req_status": "cancelled",
        "resubmitted_at": null,
        "did_count": 5,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": false,
        "allow_suborder_cancel": false,
        "allow_suborder_delete": true,
        "allow_suborder_activate": false,
        "is_master": true
      },
      {
        "port_proposal_id": 189,
        "port_req_status": "submitted",
        "resubmitted_at": null,
        "did_count": 6,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": true,
        "allow_suborder_cancel": true,
        "allow_suborder_delete": false,
        "allow_suborder_activate": false,
        "is_master": true
      },
      {
        "port_proposal_id": 186,
        "port_req_status": "submitted",
        "resubmitted_at": null,
        "did_count": 5,
        "foc_date": null,
        "failure_reason": null,
        "port_req_detail_id": null,
        "allow_suborder_edit": true,
        "allow_suborder_cancel": true,
        "allow_suborder_delete": false,
        "allow_suborder_activate": false,
        "is_master": true
      }
    ]
  }
],
"totalRecords": 109,
"enableNext": true,
}
}

Fetch Port list
POST`/port-in/view-list`

URI Parameters

HideShow

page: string (required) Example: 1
limit: string (required) Example: 10
request_phase: 'In_Progress': string (optional)
value : “In_Progress”, “Completed”, “Cancelled”, “Queue”, “Validation_Pending”, “Processing”, “Error”
did_type: string (optional) Example: LCL
value : ‘LCL’, ‘TF’, ‘INTL’
numbers: array (optional) Example: ["2012190101"]

VIEW DID LIST ¶

GET https://apicontrol.call48.com/api/v4/port-in/view-did-list?port_proposal_id=123

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "data": {
    "success": true,
    "result": [
      {
        "port_proposal_id": 201,
        "did": "7012008902",
        "lrn": "7012009999",
        "port_status": "submitted",
        "allow_did_activate": false,
        "allow_did_build": false,
        "allow_did_cancel": true,
        "allow_did_delete": false,
        "tags": null
      }
    ]
  }
}

Fetch DID list at sub order level
GET`/port-in/view-did-list{?port_proposal_id}`

URI Parameters

HideShow

port_proposal_id: Number (required) Example: 123

UPDATE REQUEST ¶

POST https://apicontrol.call48.com/api/v4/port-in/update-request

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Update Port Details
POST`/port-in/update-request`

URI Parameters

HideShow

port_req_id

number (required) Example: 12

port_proposal_id

number (optional) Example: 201

required only when update sub order details

port_req_detail

object (required)

cust_acc_name: “test 1232” (string, required)
cust_authorized_name: “test” (string, required)
cust_acc_type: “RES”, (string, required) - Value : ‘RES’, ‘BIZ’
cust_acc_number: 1234566 (string, required)
cust_acc_pin: 123 (string, optional)
activation_type: “Auto” (string, optional) - Default : ‘Auto’, Other: ‘Manual’, ‘Scheduled’
address_direction_prefix: “test” (string, optional)
address_direction_suffix: “test” (string, optional)
address_street_name_suffix: “test” (string, optional)
address_street_name: “test” (string, required)
address_number: “test” (string, required)
address_loc_value: “test” (string, optional)
address_loc_designator: “test” (string, required)
postal_code: “1234e” (string, required)
city: “test” (string, required)
desired_foc_date: “2022-05-02T00:00:00Z” (date, required) - UTC date format
btn: 64221 (string, required)
state: “MI”, (string, required)
activation_date: “2022-05-02T12:00:00-04:00” (date, required) - EST date format
email_updates : "test.user@example.com" (string, optional)
notes: ‘testing’ (string, optional)
tags: “t1, t2” (string, optional)

CANCEL ORDER ¶

POST https://apicontrol.call48.com/api/v4/port-in/cancel-order

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Cancel port or sub order
POST`/port-in/cancel-order`

URI Parameters

HideShow

port_req_id: number (optional) Example: 12
required only when cancel port
port_proposal_id: number (optional) Example: 201
required only when cancel sub order

CANCEL DID ORDER ¶

POST https://apicontrol.call48.com/api/v4/port-in/cancel-did-order

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Cancel DID Number at Order level
POST`/port-in/cancel-did-order`

URI Parameters

HideShow

port_proposal_id: number (required) Example: 201
did_number: string (required) Example: "7012004432"

FORWARDING DETAILS ¶

GET https://apicontrol.call48.com/api/v4/port-in/forwarding-details?port_req_id=12

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation",
  "data": {
    "port_req_id": 12,
    "fwd_preconfigured": false,
    "fwd_trunk_grpid": null,
    "fwd_sip_type": "NA",
    "fwd_order": "NA",
    "fwd_answering_mode": "NA",
    "fwd_device_password": null,
    "port_req_forwardings": [
      {
        "port_req_id": 256,
        "forwarding_type_id": 2,
        "sequence": 1,
        "method": "NUM",
        "value": "12356789133",
        "timeout": 30,
        "created_at": "2022-01-31T06:47:40.233Z",
        "updated_at": "2022-01-31T06:47:40.233Z"
      }
    ]
  }
}

Fetch port forwarding details
GET`/port-in/forwarding-details{?port_req_id}`

URI Parameters

HideShow

port_req_id: number (required) Example: 12

UPDATE FORWARDING ¶

POST https://apicontrol.call48.com/api/v4/port-in/update-forwarding

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Update port forwarding details
POST`/port-in/update-forwarding`

URI Parameters

HideShow

port_req_id

number (required) Example: 256

forwarding_data

array(object) (optional)

forwarding_type_id: 2 (number)
timeout: 30 (number)
value: “12356789133” (string)
method: “NUM” (string)
sequence: 1 (number)

fwd_preconfigured

boolean (optional) Example: false

DELETE REQUEST ¶

POST https://apicontrol.call48.com/api/v4/port-in/delete-request

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Delete port, sub order or DID number
POST`/port-in/delete-request`

URI Parameters

HideShow

port_request_id: number (optional) Example: 12
Required only when delete master port request
port_proposal_id: number (optional) Example: 201
Required only when delete sub order or DID number
did_number: string (optional) Example: "7012004432"
Required only when delete DID number

ACTIVATE ORDER ¶

POST https://apicontrol.call48.com/api/v4/port-in/activate-order

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Activate port or sub order
POST`/port-in/activate-order`

URI Parameters

HideShow

port_req_id: number (optional) Example: 12
Required only when need to activate master port
port_proposal_id: number (optional) Example: 201
Required only when activate sub order

ACTIVATE DID ¶

POST https://apicontrol.call48.com/api/v4/port-in/activate-did

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Activate DID Number at Order level
POST`/port-in/activate-did`

URI Parameters

HideShow

port_proposal_id: number (required) Example: 201
did_number: string (required) Example: "7012004432"

UPLOAD DOCS ¶

POST https://apicontrol.call48.com/api/v4/port-in/upload-docs

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: multipart/form-data; boundary=abcde12345
Content-Disposition: form-data; name="file"; filename="anything.csv"

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Upload docs at master or sub order level
POST`/port-in/upload-docs`

URI Parameters

HideShow

port_req_id: number (optional) Example: 12
Required only when need to upload docs at master level
port_proposal_id: number (optional) Example: 201
Required only when need to upload docs at suborder level
type: string (required) Example: 'loa'
Value : ‘loa’, ‘bill’ or ‘csr’
file: file (required) Example: file upload input

REMOVE DOCS ¶

POST https://apicontrol.call48.com/api/v4/port-in/remove-upload-docs

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Remove docs at master or sub order level
POST`/port-in/remove-upload-docs`

URI Parameters

HideShow

port_req_id: number (optional) Example: 12
Required only when need to upload docs at master level
port_proposal_id: number (optional) Example: 201
Required only when need to upload docs at suborder level
type: string (required) Example: 'loa'
Value : ‘loa’, ‘bill’ or ‘csr’
file: file (required) Example: file upload input

EXPORT LIST ¶

POST https://apicontrol.call48.com/api/v4/port-in/export-list

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

sub_order_id,status,resubmitted_at,tn,active_foc_date
201,submitted,Mon Jan 31 2022 01:41:03 GMT-0500 (Eastern Standard Time),1,

Export port, sub order or DID number list
POST`/port-in/export-list`

URI Parameters

HideShow

port_req_id: number (optional) Example: 12
Required only when need export sub order list
port_proposal_id: number (optional) Example: 201
Required only when need to export DID number list
request_phase: 'In_Progress': string (optional)
value : “In_Progress”, “Completed”, “Cancelled”, “Queue”, “Validation_Pending”, “Processing”, “Error”
did_type: string (optional) Example: LCL
value : ‘LCL’, ‘TF’, ‘INTL’
numbers: array (optional) Example: ["2012190101"]

FOC READY ¶

POST https://apicontrol.call48.com/api/v4/port-in/view-foc-list

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "data": {
    "count": 1,
    "rows": [
      {
        "port_proposal_id": 275,
        "did": "2012190101",
        "port_status": "activated",
        "foc_date": null,
        "port_req_id": 315,
        "activation_type": "Auto",
        "activation_date": null
      }
    ]
  }
}

Fetch FOC Ready List
POST`/port-in/view-foc-list`

URI Parameters

HideShow

page: string (required) Example: 1
limit: string (required) Example: 10
activation_type: string (optional) Example: 'Auto'
Value : ‘Auto’, ‘Manual’, ‘Scheduled’
numbers: array (optional) Example: ["2012190101"]

VIEW FOC DID ¶

GET https://apicontrol.call48.com/api/v4/port-in/view-did-activation?did="7012001183"&port_proposal_id=76

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "data": {
    "success": true,
    "data": {
      "port_proposal_id": 76,
      "did": "7012001183",
      "port_status": "foc_received",
      "foc_date": "2022-01-21T00:00:00.000Z",
      "port_req_id": 136,
      "activation_type": "Auto",
      "activation_date": "2022-01-21T17:00:00.000Z"
    }
  }
}

Fetch Activation Port details
GET`/port-in/view-did-activation{?did}{&port_proposal_id}`

URI Parameters

HideShow

did: string (required) Example: "7012001183"
port_proposal_id: number (required) Example: 76

UPDATE FOC DID ¶

POST https://apicontrol.call48.com/api/v4/port-in/update-activation

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
  "code": 200,
  "message": "Successful Operation"
}

Update activation details
POST`/port-in/update-activation`

URI Parameters

HideShow

activation_date: string (required) Example: '2022
01-21T12:00:00-05:00’ - EST Date format
activation_type: string (required) Example: 'Auto'
did: string (required) Example: "7012001183"
port_proposal_id: number (required) Example: 76

PROBLEMATIC PORTS ¶

POST https://apicontrol.call48.com/api/v4/port-in/view-rejection-list

Responses200

Headers

Authorization: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEyOSwidXVpZCI6IjRmN2ZiMjQxLTRhZWMtNDczMS1iNWNmLTVmNTRhMTNhODRjOSIsInVzZXJUeXBlIjoiYWNjb3VudHMiLCJhY2NvdW50VHlwZSI6ImFjY291bnQiLCJpYXQiOjE2MTMxMjEyOTQsImV4cCI6MTYxMzIwNzY5NH0.djuUlgpS6uLfF9HB3M0ltgJVbkBeCqUiAGLPtX6kbA7A5JhA_PVS8x6Y5zevLUuY1cI6s_n-Dxr-yxJT2KjJ8w"
Content-Type: application/json

Body

{
"code": 200,
"data": {
"success": true,
"result": {
  "request_phase_list": [
    {
      "request_phase": "Queue"
    },
    {
      "request_phase": "Error"
    },
    {
      "request_phase": "Validation_Pending"
    },
    {
      "request_phase": "In_Progress"
    },
    {
      "request_phase": "Completed"
    },
    {
      "request_phase": "Cancelled"
    }
  ],
  "atl_status_list": [
    {
      "atl_status": "LSR Pending"
    },
    {
      "atl_status": "Active"
    },
    {
      "atl_status": "Authorized"
    },
    {
      "atl_status": "LSR Rejected"
    },
    {
      "atl_status": "ActionRequired"
    },
    {
      "atl_status": "Pending"
    },
    {
      "atl_status": "Canceled"
    },
    {
      "atl_status": "CancelPending"
    },
    {
      "atl_status": "ActivatePending"
    },
    {
      "atl_status": "Conflict"
    },
    {
      "atl_status": "PreOrderPending"
    },
    {
      "atl_status": "DisconnectPending"
    },
    {
      "atl_status": "ReceivedFoc"
    },
    {
      "atl_status": "Rejected"
    },
    {
      "atl_status": "Submitted"
    },
    {
      "atl_status": "Supplemented"
    },
    {
      "atl_status": "CSRPending"
    },
    {
      "atl_status": "CSRRequested"
    },
    {
      "atl_status": "CSRModified"
    },
    {
      "atl_status": "CSRInvalid"
    },
    {
      "atl_status": "CSREscalated"
    },
    {
      "atl_status": "CSRReview"
    },
    {
      "atl_status": "CSRReceived"
    },
    {
      "atl_status": "CSRApproved"
    }
  ],
  "totalRecords": 3,
  "result": [
    {
      "port_proposal_id": 358,
      "port_req_id": 390,
      "port_req_status": "retry",
      "losing_sp": "Call 48 4125/1",
      "target_sp": "IPH",
      "resubmitted_at": null,
      "did_count": 1,
      "failure_reason": "LSR rejected || Rejection reason  ACCN : Incorrect Account Number",
      "foc_date": null,
      "request_phase": "In_Progress",
      "order_id": "515J-637868274879776052",
      "order_status": "Rejected"
    },
    {
      "port_proposal_id": 315,
      "port_req_id": 347,
      "port_req_status": "retry",
      "losing_sp": "Cox Communications 7661 TEST/1",
      "target_sp": "IPH",
      "resubmitted_at": null,
      "did_count": 1,
      "failure_reason": "Rejection reason  ACCN : Incorrect Account Number",
      "foc_date": null,
      "request_phase": "Completed",
      "order_id": "515J-637844376990227744",
      "order_status": "PreOrderPending"
    },
    {
      "port_proposal_id": 178,
      "port_req_id": 229,
      "port_req_status": "retry",
      "losing_sp": "Cox Communications 7661 TEST/1",
      "target_sp": "IPH",
      "resubmitted_at": "2022-04-08T16:22:09.402Z",
      "did_count": 6,
      "failure_reason": "Rejection reason  ACCN : Incorrect Account Number",
      "foc_date": null,
      "request_phase": "In_Progress",
      "order_id": "515J-637783674005809513",
      "order_status": "Rejected"
    }rder_status": "Rejected"
    }
  ],
  "enableNext": false
}
}
}

Fetch problematic port list
POST`/port-in/view-rejection-list`

URI Parameters

HideShow

page: string (required) Example: 1
limit: string (required) Example: 10
request_phase: 'In_Progress': string (optional)
value : “In_Progress”, “Completed”, “Cancelled”, “Queue”, “Validation_Pending”, “Processing”, “Error”
did_type: string (optional) Example: LCL
value : ‘LCL’, ‘TF’, ‘INTL’
numbers: array (optional) Example: ["2012190101"]

Generated by aglio on 06 Jun 2022

API Endpoint

Overview ¶

Request Format & Authorization ¶

Invalid Token Sample Response ¶

Headers

Body

Invalid Token Sample ResponsePOST/purchase

LOGIN ¶

LOGIN ¶

Headers

Body

Customer LogInPOST/login

LOGIN ¶

Headers

Body

SP Admin LogInPOST/admin_login

DID ¶

DID Lookup ¶

Headers

Body

Search LocalGET/search{?type}{&state}{&ratecenter}{&npa}{&nxx}{&limit}

Headers

Body

Search TollfreeGET/search{?type}{&npa}{&limit}

Headers

Body

Search International NumberGET/search{?type}

Purchase DID ¶

Headers

Body

Headers

Body

Purchase local numbersPOST/purchase

Headers

Body

Headers

Body

Purchase tollfree numbersPOST/purchase

Headers

Body

Headers

Body

Purchase international numbersPOST/purchase

Bulk Purchase local numbers ¶

Headers

Body

Headers

Body

Bulk Purchase local numbersPOST/lcl-did-bulk-purchase/new

List Bulk Order Requests ¶

Headers

Body

List Bulk Order RequestsGET/lcl-did-bulk-purchase/list{?page}{&limit}{&order_type}{&status}{&order_no}

Download Bulk Order Summary Report ¶

Headers

Body

Download Bulk Order Summary ReportGET/lcl-did-bulk-purchase/summary_report/{bulk_order_id}

Download Bulk Order DID Report ¶

Headers

Body

Download Bulk Order DID ReportGET/lcl-did-bulk-purchase/did_report/{bulk_order_id}

DID ¶

Headers

Body

Get DIDGET/dids{?type}{&page}{&max}

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Remove DIDDELETE/dids

411 ¶

Headers

Body

Update 411GET/update411{?number}{&enabled}{&type}{&country}{&state}{&lstgn}{&lstnm}{&strt}{&locnm}{&zip}

911 ¶

Headers

Request Format & Authorization

Invalid Token Sample Response
POST`/purchase`

Customer LogIn
POST`/login`

SP Admin LogIn
POST`/admin_login`

Search Local
GET`/search{?type}{&state}{&ratecenter}{&npa}{&nxx}{&limit}`

Search Tollfree
GET`/search{?type}{&npa}{&limit}`

Search International Number
GET`/search{?type}`

Purchase local numbers
POST`/purchase`

Purchase tollfree numbers
POST`/purchase`

Purchase international numbers
POST`/purchase`

Bulk Purchase local numbers
POST`/lcl-did-bulk-purchase/new`

List Bulk Order Requests
GET`/lcl-did-bulk-purchase/list{?page}{&limit}{&order_type}{&status}{&order_no}`

Download Bulk Order Summary Report
GET`/lcl-did-bulk-purchase/summary_report/{bulk_order_id}`

Download Bulk Order DID Report
GET`/lcl-did-bulk-purchase/did_report/{bulk_order_id}`

Get DID
GET`/dids{?type}{&page}{&max}`

Remove DID
DELETE`/dids`

Update 411
GET`/update411{?number}{&enabled}{&type}{&country}{&state}{&lstgn}{&lstnm}{&strt}{&locnm}{&zip}`

Update 911
GET`/update911{?number}{&enabled}{&country}{&state}{&streetnumber}{&streetname}{&city}{&zipcode}{&addresstypenumber}`

Update Tags
GET`/update_tags{?number}{&tags}`

Update Fax
POST`/update_fax`

Update Forwarding
POST`/update_forwarding`

Create Did Cnam
POST`/did/create-cnam`

Create trunk group
POST`/trunkgrp/create`

Update trunk group
PUT`/trunkgrp/update`

List trunk group
GET`/trunkgrp/list{?limit}`

Get Countries
GET`/countries`

Get States
GET`/states`

Get Rate Center List By State
GET`/ratecenter{?state}`

Verify Address
GET`/verifyaddress{?country}{&state}{&name}{&streetnumber}{&streetname}{&city}{&zipcode}{&location}`