Qodex.ai

List Fax URIs

GET {{baseUrl}}/v1/configuration/faxuri?pageNumber=0&pageSize=20

Request Params

KeyDatatypeRequiredDescription
faxUriIdstringThe identifier of the fax uri.
deliveryMethodstringThis is the delivery method on which you want to filter your list of Fax URIs. The possible values are SMTP and HTTP_POST.
faxFileFormatstringThis is the file format on which you want to filter your list of Fax URIs. The possible values are Tiff and Pdf.
uristringThis is the URI on which you want to filter your list of Fax URIs.
csidstringThis to filter in/out the Fax URIs for which CSID (Called subscriber identification) is enabled.
pageNumbernumberThe page number, starting at 0.
pageSizenumberThe page size (max number of entities that are displayed in the response).

HEADERS

KeyDatatypeRequiredDescription
apikeystringAuthentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
Acceptstring

RESPONSES

status: OK

{"faxUris":[{"faxUriId":7,"deliveryMethod":"SMTP","faxFileFormat":"Pdf","uri":"https://fax.smtp.voxbone.com","csid":"CSID","subject":"This is an example subject","body":"This is an example body","useHtml":"true"},{"faxUriId":3,"deliveryMethod":"HTTP_POST","faxFileFormat":"Pdf","uri":"https://fax.voxbone.com","csid":"CSID","subject":null,"body":null,"useHtml":"false"},{"faxUriId":9,"deliveryMethod":"HTTP_POST","faxFileFormat":"Pdf","uri":"https://voxbone.com","csid":"230958290835109485","subject":null,"body":null,"useHtml":"false"}],"resultCount":3}