Skip to main content

List Verification Requests

GET 

/messaging_tollfree/verification/requests

Get a list of previously-submitted tollfree verification requests

Request

Query Parameters

    page Pagerequired

    Possible values: >= 1

    page_size Page Sizerequired

    Possible values: >= 1

        Request this many records per page

    This value is automatically clamped if the provided value is too large.

    date_start date-time
    date_end date-time
    status VerificationStatus

    Possible values: [Verified, Rejected, Waiting For Vendor, Waiting For Customer, In Progress]

    phone_number Phone Number

Responses

200: Successful Response

Schema

    records

    object[]

    The records yielded by this request

  • Array [

  • businessName Businessnamerequired
    corporateWebsite Corporatewebsiterequired
    businessAddr1 Businessaddr1required
    businessAddr2 Businessaddr2
    businessCity Businesscityrequired
    businessState Businessstaterequired
    businessZip Businessziprequired
    businessContactFirstName Businesscontactfirstnamerequired
    businessContactLastName Businesscontactlastnamerequired
    businessContactEmail Businesscontactemailrequired
    businessContactPhone Businesscontactphonerequired
    messageVolume object

    Message Volume Enums

    phoneNumbers

    object[]

    required

  • Array [

  • phoneNumber Phonenumberrequired
  • ]

  • useCase object

    Tollfree usecase categories

    useCaseSummary Usecasesummaryrequired
    productionMessageContent Productionmessagecontentrequired
    optInWorkflow Optinworkflowrequired

    optInWorkflowImageURLs

    object[]

    required

  • Array [

  • url urirequired

    Possible values: non-empty and <= 2083 characters

  • ]

  • additionalInformation Additionalinformationrequired
    isvReseller Isvresellerrequired
    webhookUrl Webhookurl
    id uuidrequired
    verificationStatus object

    Tollfree verification status

    reason Reason
  • ]

  • total_records Total Records

    The total amount of records for these query parameters

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...