Operations at https://rest.interfax.net/outbound
This page describes the service operations at this endpoint.
| Uri | Method | Description |
|---|---|---|
| /addressbooks | GET | Service at https://rest.interfax.net/outbound/addressbooks?limit={LIMIT}&offset={OFFSET} |
| /contacts/{id} | GET | Service at https://rest.interfax.net/outbound/contacts/{ID} |
| /help/mediatype | GET | Service at https://rest.interfax.net/outbound/help/mediatype |
| /search | GET | Service at https://rest.interfax.net/outbound/search?ids={IDS}&reference={REFERENCE}&dateFrom={DATEFROM}&dateTo={DATETO}&status={STATUS}&userId={USERID}&faxNumber={FAXNUMBER}&sortOrder={SORTORDER}&offset={OFFSET}&limit={LIMIT} |
| /seek | GET | Service at https://rest.interfax.net/outbound/seek?ids={IDS}&reference={REFERENCE}&dateFrom={DATEFROM}&dateTo={DATETO}&status={STATUS}&userId={USERID}&faxNumber={FAXNUMBER}&sortOrder={SORTORDER}&offset={OFFSET}&limit={LIMIT} |
| /sendingprofile | GET | Service at https://rest.interfax.net/outbound/sendingprofile |
| {id}/resendcallback | POST | Service at https://rest.interfax.net/outbound/{ID}/resendcallback |
| batches | POST | Service at https://rest.interfax.net/outbound/batches?list={LIST}&csid={CSID}&reference={REFERENCE}&resolution={RESOLUTION}&rendering={RENDERING}&pageOrientation={PAGEORIENTATION}&pageSize={PAGESIZE}&fitToPage={FITTOPAGE}&retriesToPerform={RETRIESTOPERFORM}&postpone={POSTPONE}&pageHeader={PAGEHEADER}&barcode={BARCODE}&replyAddress={REPLYADDRESS} |
| GET | Service at https://rest.interfax.net/outbound/batches?lastID={LASTID}&limit={LIMIT}&sortOrder={SORTORDER}&allUsers={ALLUSERS} | |
| batches/{id} | GET | Service at https://rest.interfax.net/outbound/batches/{ID} |
| batches/{id}/cancel | POST | Service at https://rest.interfax.net/outbound/batches/{ID}/cancel |
| batches/{id}/children | GET | Service at https://rest.interfax.net/outbound/batches/{ID}/children?limit={LIMIT}&offset={OFFSET} |
| batches/{id}/hide | POST | Service at https://rest.interfax.net/outbound/batches/{ID}/hide |
| batches/{id}/image | GET | Service at https://rest.interfax.net/outbound/batches/{ID}/image?format={FORMAT} |
| batches/{id}/resend | POST | Service at https://rest.interfax.net/outbound/batches/{ID}/resend?reference={REFERENCE}&sendAlsoOK={SENDALSOOK} |
| documents | POST | Service at https://rest.interfax.net/outbound/documents?size={FILESIZE}&name={FILENAME}&disposition={DISPOSITION}&sharing={SHARING} |
| GET | Service at https://rest.interfax.net/outbound/documents?limit={LIMIT}&offset={OFFSET} | |
| documents/{id} | POST | Service at https://rest.interfax.net/outbound/documents/{ID} |
| GET | Service at https://rest.interfax.net/outbound/documents/{ID} | |
| DELETE | Service at https://rest.interfax.net/outbound/documents/{ID} | |
| faxes | POST | Service at https://rest.interfax.net/outbound/faxes?faxNumber={FAXNUMBER}&contact={CONTACT}&csid={CSID}&reference={REFERENCE}&resolution={RESOLUTION}&rendering={RENDERING}&pageOrientation={PAGEORIENTATION}&pageSize={PAGESIZE}&fitToPage={FITTOPAGE}&retriesToPerform={RETRIESTOPERFORM}&postponeTime={POSTPONETIME}&pageHeader={PAGEHEADER}&barcode={BARCODE}&replyAddress={REPLYADDRESS} |
| GET | Service at https://rest.interfax.net/outbound/faxes?lastID={LASTID}&limit={LIMIT}&sortOrder={SORTORDER}&userId={USERID} | |
| faxes/{id} | GET | Service at https://rest.interfax.net/outbound/faxes/{ID} |
| faxes/{id}/cancel | POST | Service at https://rest.interfax.net/outbound/faxes/{ID}/cancel |
| faxes/{id}/hide | POST | Service at https://rest.interfax.net/outbound/faxes/{ID}/hide |
| faxes/{id}/image | GET | Service at https://rest.interfax.net/outbound/faxes/{ID}/image?format={FORMAT} |
| faxes/{id}/resend | POST | Service at https://rest.interfax.net/outbound/faxes/{ID}/resend?faxNumber={FAXNUMBER} |
| faxes/{id}/results | GET | Service at https://rest.interfax.net/outbound/faxes/{ID}/results |
| faxes/{id}/status | GET | Service at https://rest.interfax.net/outbound/faxes/{ID}/status |
| faxes/completed | GET | Service at https://rest.interfax.net/outbound/faxes/completed?ids={IDS} |