SIsinch
Services

Create a service

Changed on

Creates a new service that you can use to set default configuration values.

post/v3/projects/{projectId}/services

Request

  • Base URL
    https://fax.api.sinch.com
  • URL
    https://fax.api.sinch.com/v3/projects/{projectId}/services
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Request body

idstring

ID of the fax service used.

namestring

A friendly name for the service. Maximum is 60 characters.

incomingWebhookUrlstring

The URL to which Sinch will post when someone sends a fax to your Sinch number. To accept incoming faxes this must be set and your Sinch phone number must be configured to receive faxes.

Note: If a webhook uses basicauth credentials, when the webhook URL is retrieved those credentials are masked. It is not possible to retrieve previously-set credentials through the API.

webhookContentType'multipart/form-data' | 'application/json'

The content type of the webhook.

defaultForProjectboolean

If set to true this is the service used to create faxes when no serviceId is specified in the API endpoints.

defaultFromstring

One of your Sinch numbers connected to this service or any of your verified numbers.

numberOfRetriesinteger

The number of times to retry sending a fax if it fails. Default is 3. Maximum is 5.

retryDelaySecondsinteger

The number of seconds to wait between retries if the fax is not yet completed.

imageConversionMethod'HALFTONE' | 'MONOCHROME'

Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. Defaults to value selected on Fax Service object.

coverPageIdstring ulid

If a value it will always add that cover page id to outbound faxes

saveOutboundFaxDocumentsboolean

Save fax documents with Sinch when you send faxes. Fax records are retained for 13 months. Records older than 13 months are deleted.

saveInboundFaxDocumentsboolean

Save fax documents with Sinch when you receive faxes. Fax records are retained for 13 months. Records older than 13 months are deleted.

scanIncomingBarcodesboolean

If set to true, barcodes will be detected on incoming faxes.

inProgressNotificationsboolean

If set to true, you will receive a webhook notification for each page sent on an outbound fax.

projectIdstring

The Id of the project associated with the call.

resolution'FINE' | 'SUPERFINE'

The resolution for the fax. If this is set at the service, this applies to all faxes sent using that service. If this is set on the fax, this will override the service setting.

createdAtstring date-time

The date and time the service was created.

updatedAtstring date-time

The date and time the service was last updated.

Example request

{
  "id": "01GVRB50KEQFFE1SGMPFRNBG6J",
  "name": "Default service",
  "incomingWebhookUrl": "https://yourserver/incomingFax",
  "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3"
}

Response

The newly created service

idstring

ID of the fax service used.

namestring

A friendly name for the service. Maximum is 60 characters.

incomingWebhookUrlstring

The URL to which Sinch will post when someone sends a fax to your Sinch number. To accept incoming faxes this must be set and your Sinch phone number must be configured to receive faxes.

Note: If a webhook uses basicauth credentials, when the webhook URL is retrieved those credentials are masked. It is not possible to retrieve previously-set credentials through the API.

webhookContentType'multipart/form-data' | 'application/json'

The content type of the webhook.

defaultForProjectboolean

If set to true this is the service used to create faxes when no serviceId is specified in the API endpoints.

defaultFromstring

One of your Sinch numbers connected to this service or any of your verified numbers.

numberOfRetriesinteger

The number of times to retry sending a fax if it fails. Default is 3. Maximum is 5.

retryDelaySecondsinteger

The number of seconds to wait between retries if the fax is not yet completed.

imageConversionMethod'HALFTONE' | 'MONOCHROME'

Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. Defaults to value selected on Fax Service object.

coverPageIdstring ulid

If a value it will always add that cover page id to outbound faxes

saveOutboundFaxDocumentsboolean

Save fax documents with Sinch when you send faxes. Fax records are retained for 13 months. Records older than 13 months are deleted.

saveInboundFaxDocumentsboolean

Save fax documents with Sinch when you receive faxes. Fax records are retained for 13 months. Records older than 13 months are deleted.

scanIncomingBarcodesboolean

If set to true, barcodes will be detected on incoming faxes.

inProgressNotificationsboolean

If set to true, you will receive a webhook notification for each page sent on an outbound fax.

projectIdstring

The Id of the project associated with the call.

resolution'FINE' | 'SUPERFINE'

The resolution for the fax. If this is set at the service, this applies to all faxes sent using that service. If this is set on the fax, this will override the service setting.

createdAtstring date-time

The date and time the service was created.

updatedAtstring date-time

The date and time the service was last updated.

Example response

{
  "id": "01GVRB50KEQFFE1SGMPFRNBG6J",
  "name": "Default service",
  "incomingWebhookUrl": "https://yourserver/incomingFax",
  "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3"
}

Changes