Smart Carrier | API | Call Shaper - Web Service

Smart Carrier | API | Call Shaper - Web Service

The SmartCarrier Call Shaper Module will connect your systems to our web service.  These services include STIR/SHAKEN, Caller ID Assessments, National DNC Scrubbing, Disconnected Number Analysis, and others.  


In order to use this module, you will need an API key.  To get your API Key, please contact us at support@tiltx.com.

Web Service URL: https://api.smartcarrier.io/v2/shaper?

Parameters:
      ToNumber, FromNumber
Headers:
      x-api-key


Sample API Response:

{

    "RequestGuid": "cb684abe-456f-43e0-83be-0ecc65fd30d9",

    "AccountGuid": "a4a41eb4-0774-4c90-a4aa-7fa1d5542ba4",

    "ToNumber": "12028883803",

    "FromNumber": "8003816311",

    "IPAddress": "34.225.24.242",

    "IsDNC": "false",

    "IsDisconnected": "false",

    "CallerIDToUse": "2025551212",

    "Identity": "eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9jZXJ0aWZpY2F0ZXMuY2xlYXJpcC5jb20vZmRmYjMzMjgtYjc1NC00YTBkLThiMzQtZGUzMGIwOGFkYWMyLzJhZDc4ZDAyM2FmZGEyYzg1YjY3NWE5NTcxYmFjMjI4LmNydCJ9.eyJhdHRlc3QiOiJDIiwiZGVzdCI6eyJ0biI6WyIxOTU0NTEyNzI5NCJdfSwiaWF0IjoxNjIyMTM4Nzg2LCJvcmlnIjp7InRuIjoiODY2NTYyMzk0MCJ9LCJvcmlnaWQiOiJhMTU2MTcyOS01N2I2LTRlZWUtODFhYi03NGUwYTgzYTk4ZDYifQ.OmYIRxnlNowdZct8uyTNH1ynjouNIC0nZvZK6FoeX-rSwOoo6WeDCfGuQQ8zcLqmIG3vu0JmxkGpOLa9b8Ly3Q;info=<https://certificates.smartcarrier.io/fdfb3328-b754-4a0d-8b34-de30b08adac2/2ad78d023afda2c85b675a9571bac228.crt>;alg=ES256;ppt=shaken",

    "CAID": "3dad418d-0232-412c-a4bc-7c42b3753b4b",

    "AttestationLevel": "A",

    "TILTXID": "cb684abe-456f-43e0-83be-0ecc65fd30d9",

    "ServiceData": null,

    "RequestedAt": "2021-05-27T18:06:26.0412888Z",

    "CompletedAt": "2021-05-27T18:06:26.1258189Z",

    "ProcessingTime": "84.5301",

    "ReturnCode": 200,

    "ReturnStatus": "Success"

}

 

What do the response values mean?

  • RequestGuid: a unique identifier assigned to this request. 

  • AccountGuid: a unique identifier assigned to your account.

  • ToNumber: The phone number sent in the 'ToNumber' parameter.

  • FromNumber: The phone number sent in the 'FromNumber' parameter.

  • IPAddress: The IP address where the request originated from.

  • IsDNC: Was this number found in the National DNC.

  • IsDisconnected: Is this number in service or not.

  • CallerIDToUse: A NumberRisk setting telling your system which caller ID should be used.

  • Identity: The token assigned to the phone call.

  • CAID: The unique identifier assigned to this token.

  • AttestationLevel: The attestation level associated with the FromNumber.

  • TILTXID: the tracking identifier for this request.

  • RequestedAt: When we received the request to provide a token.

  • CompletedAt: When the request finished processing.

  • ProcessingTime: How much time, in milliseconds, this request required.

  • ReturnCode:
    200: Succussful
    404: ReturnStatus will contain the reason.
    503: ReturnStatus will contain the reason.

If you have any questions, please feel free to reach out to TILTX support - support@tiltx.com