Voice Voip API

Voice VoIP APIs

The Voice VoIP API Cluster contains a set of APIs that helps us to obtain information of voice services like VoIP.

/voice/v1/voip/ get

get

Used to retrieve the RAML file in plain text form
Scopes: Not secured

Request
Response

Query Parameters

raml: (string)
no value should be assigned.

HTTP status code 200

Got RAML successfully.

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

/voice/v1/voip/{id}/numbers get

get

This API allows to get the phone numbers of a VoIP group.
Scopes: To use this API, the scope read-voip-numbers is needed.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: read-voip-number.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

HTTP status code 200

Got numbers successfully.

Body

Type: application/json

Schema:

{  
  "type":"array",
  "$schema":"http://json-schema.org/draft-04/schema#",
  "description":"The list of phone numbers",
  "minItems": 0,
  "uniqueItems":true,
  "items":{  
    "type":"string",
    "minLength": 1
  }
}

Example:

[
    "+41316784500",
  "+41316784510",
    "+41316784520"
]

HTTP status code 400

Bad Request. Invalid Parameter.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_PARAMETER",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

/voice/v1/voip/{id}/phoneNumbers/{phoneNumber}/phonebooks get

get

Used to retrieve the phonebooks of the specific voip account.
Scopes: To use this API, the scope read-voip-phonebook is needed.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: read-voip-phonebook.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Query Parameters

type: (one of enterprise)
The type of the phonebook to get entries from.
If omitted, all entries are returned.
Possible value:
- enterprise: This parameter allows to get the enterprise directory with employees and recorded customers or suppliers.
Example:
```
enterprise
```

HTTP status code 200

Got phonebooks successfully.

Body

Type: application/json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema#",
  "title":"Phonebook entries",
  "type":"array",
  "minItems":0,
  "items":{  
    "type":"object",
    "required":[  
      "lastName",
      "firstName",
      "phoneNumbers",
      "type"
    ],
    "properties":{  
      "lastName":{  
        "type":"string",
        "minLength":1
      },
      "firstName":{  
        "type":"string"
      },
      "phoneNumbers":{  
        "type":"array",
        "minItems":1,
        "items":{  
          "type":"string",
          "minLength":1
        }
      },
      "type":{  
        "enum":[  
          "enterprise"
        ],
        "description": "enterprise: entry belonging to the enterprise phonebook (containing employees, customers, suppliers)."
      }
    }
  }
}

Example:

[  
  {  
    "lastName":"Beutlin",
    "firstName":"Frodo",
    "phoneNumbers":[  
      "0434562300",
      "0223064646"
    ],
    "type":"enterprise"
  },
  {  
    "lastName":"Muster",
    "firstName":"Max",
    "phoneNumbers":[  
      "0318981347",
      "0796898970"
    ],
    "type":"enterprise"
  }
]

HTTP status code 400

Bad Request. Invalid Parameter.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_PARAMETER",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

/voice/v1/voip/{id}/phoneNumbers/{phoneNumber}/calls get post

get

This API contains the call history of a customers phone. The call history contains placed, received and missed calls.
Scopes: To use this API, the scope read-voip-calls is needed.

post

This API innitiates an call.
Scopes: To use this API, the scope write-voip-calls is needed and the Attribute sso.bwserialnumber bound to the token.

This API contains the call history of a customers phone. The call history contains placed, received and missed calls.
Scopes: To use this API, the scope read-voip-calls is needed.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: read-voip-calls.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Query Parameters

type: (one of placed, received, missed)
The type of the call to get entries for.
If omitted, all entries are returned.
Possible values:
- placed: The outgoing calls.
- received: The received calls.
- missed: The missed calls.
Example:
```
placed
```

HTTP status code 200

Got calls successfully.

Body

Type: application/json

Schema:

{  
  "type":"array",
  "$schema":"http://json-schema.org/draft-04/schema#",
  "description":"",
  "minItems":0,
  "uniqueItems":true,
  "items":{
    "type":"object",
    "required":[  
      "countryCode",
      "phoneNumber",
      "name",
      "time",
      "callLogId",
      "type"
    ],
    "properties":{  
      "countryCode":{  
        "type":"string",
        "minLength":1
      },
      "phoneNumber":{  
        "type":"string",
        "minLength":1
      },
      "name":{  
        "type":"string"
      },
      "time":{  
        "type":"string",
        "minLength":1
      },
      "callLogId":{  
        "type":"string",
        "minLength":1
      },
      "type":{  
        "enum":[  
          "placed",
          "received",
          "missed"
        ],
        "description": "placed: outgoing calls, received: received calls, missed: missed calls."
      }
    }
  }
}

Example:

[  
  {  
    "countryCode":"41",
    "phoneNumber":"0454137224",
    "name":"Unavailable",
    "time":"2013-01-15T13:19:21.242+01:00",
    "callLogId":"42246761:0",
    "type":"received"
  },
  {  
    "countryCode":"41",
    "phoneNumber":"0318989923",
    "name":"Ferdinand Huber",
    "time":"2014-01-15T13:14:21.242+01:00",
    "callLogId":"196194149:0",
    "type":"placed"
  }
]

HTTP status code 400

Bad Request. Invalid Parameter.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_PARAMETER",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

This API innitiates an call.
Scopes: To use this API, the scope write-voip-calls is needed and the Attribute sso.bwserialnumber bound to the token.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: write-voip-calls.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "Initial call",
  "type": "object",
  "required": [
    "source",
    "target"
  ],
  "properties": {
    "source": {
      "description": "source number",
      "type": "string",
       "minLength":1
    },
    "target": {
      "description": "target number",
      "type": "string",
       "minLength":1
    }
  }
}

Example:

{ 
  "target" : "+41797739906"
}

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": ["ok"]
    }
  },
  "required": [
    "status"
  ]
}

Example:

{
  "status":"ok"
}

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 415

The request has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "415",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "The request entity has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

/voice/v1/voip/{id}/phoneNumbers/{phoneNumber}/forwardings get

get

This API allows to get the current settings for the call forwarding of a phone number.
Scopes: To use this API, the scope read-voip-callforwardings is needed.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: read-voip-callforwardings.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

HTTP status code 200

Got callForwarding setting successfully.

Body

Type: application/json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema",
  "type":"array",
  "minItems": 4,
  "uniqueItems":true,
  "items":{  
    "type":"object",
    "required": [
        "type",
        "active"
    ],
    "properties":{  
      "type":{  
        "description":"user's account number",
        "enum":[  
          "busy",
          "noAnswer",
          "unavailable",
          "unconditional"
        ]
      },
      "active":{  
        "type":"boolean"
      },
      "target":{  
        "description":"target phone number used to forward calls",
        "type":"string"
      },
      "numberOfRings":{  
        "description":"the number of rings until a call is redirected - mandatory for type=noAnswer; (range: 0;2-20)",
        "type": "integer",
      "minimum": 0,
        "maximum": 20
      }
    }
  }
}

Example:

[
    {
        "type": "busy",
        "active": false
    },
    {
        "type": "noAnswer",
        "active": true,
        "target": "0316784530",
        "numberOfRings": 5
    },
    {
        "type": "unavailable",
        "active": true,
        "target": "0316784500"
    },
    {
        "type": "unconditional",
        "active": false,
        "target": "0791234567"
    }
]

HTTP status code 400

Bad Request. Invalid Parameter.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_PARAMETER",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

/voice/v1/voip/{id}/phoneNumbers/{phoneNumber}/forwardings/{type} put delete

put

This API it allows to set the call forwarding configuration of a specific type.
Scopes: To use this API, the scope write-voip-callforwardings is needed.

delete

Used to delete all forwarding entries.
A further GET will deliver an empty list.

This API it allows to set the call forwarding configuration of a specific type.
Scopes: To use this API, the scope write-voip-callforwardings is needed.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: write-voip-callforwardings.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```
type: (one of busy, noAnswer, unavailable, unconditional)
This API it allows to activate or deactivate the call forwarding of a phone number. The type of the call to forward.
The type parameters:
- unconditional: all calls are immediately forwarded.
- unavailable: no device is registered to the specific phone number.
- busy: the called number is already in a call
- noAnswer: the call isn't answered within a given time
Example:
```
busy
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "required": [
   "target",
   "active"
  ],
  "properties": {
    "target": {
      "description": "target phone number used to forward calls",
      "type": "string",
      "pattern": "^(0|\\+41|0041)[1-9][0-9]{8}$"
    },
    "active":{  
      "type":"boolean"
    },
    "numberOfRings": {
      "description":"the number of rings until a call is redirected - mandatory for type=noAnswer; (range: 0;2-20)",
      "type": "integer",
      "minimum": 0,
      "maximum": 20
    }
  }
}

Example:

{
  "target": "+41797739905",
  "active": true,
  "numberOfRings": 12
}

HTTP status code 200

callForwarding setting successfully done

Headers

Location: (string)
The configuration for call Forwarding has been successfully done
Example:
```
https://api.swisscom.com/voice/v1/voip/me/phoneNumbers/0316784534/forwardings
```

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 415

The request has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "415",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "The request entity has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

Used to delete all forwarding entries.
A further GET will deliver an empty list.

Secured by

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```
type: (one of busy, noAnswer, unavailable, unconditional)
This API it allows to activate or deactivate the call forwarding of a phone number. The type of the call to forward.
The type parameters:
- unconditional: all calls are immediately forwarded.
- unavailable: no device is registered to the specific phone number.
- busy: the called number is already in a call
- noAnswer: the call isn't answered within a given time
Example:
```
busy
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

HTTP status code 200

Deleted forwardings for the given Number.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": ["ok"]
    }
  },
  "required": [
    "status"
  ]
}

Example:

{
  "status":"ok"
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

/voice/v1/voip/{id}/phoneNumbers/{phoneNumber}/simrings patch get put delete

patch

This resource allows adding new phone numbers to the resource, which shall ring simultaneously. PATCH of JSON objects according to this IETF spec: https://tools.ietf.org/html/rfc7386

get

This resource returns the list of phone numbers, which ring simultaneously.

put

This resource allows to set a list of phone numbers, which ring simultaneously. The list sent in the body replaces the content of the resource. Empty lists are not allowed to be sent.

delete

Used to delete all simRing entries.
A further GET will deliver an empty list.

This resource allows adding new phone numbers to the resource, which shall ring simultaneously. PATCH of JSON objects according to this IETF spec: https://tools.ietf.org/html/rfc7386

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: write-voip-simrings.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```

Body

Type: application/merge-patch+json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"array",
  "description":"The list of phone or SIP numbers",
  "minItems": 1,
  "maxItems": 10,
  "uniqueItems": true,
  "items":{  
    "description": "one of the numbers that ring simultaneously. Phonenumbers or SIP Numbers are allowed.",  
    "type": "string",
    "minLength": 1,
    "pattern": "(^(\\+|00|0)[1-9][0-9]{8,15}$)|(^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$)"
  }
}

Example:

[
  "+41316784500",
  "+41316784510",
  "+41316784520"
]

HTTP status code 200

simring configuration successfully updated

Headers

Location: (string)
The configuration for simrings has been successfully done
Example:
```
https://api.swisscom.com/voice/v1/voip/me/phoneNumbers/0316784534/simrings
```

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 415

The request has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "415",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "The request entity has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

This resource returns the list of phone numbers, which ring simultaneously.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: read-voip-simrings.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

HTTP status code 200

Got simrings configuration successfully.

Body

Type: application/json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"array",
  "description":"The list of phone numbers",
  "minItems": 0,
  "uniqueItems": true,
  "items":{  
    "description": "one of the phonenumbers that ring simultaneously",  
    "type": "string",
    "minLength": 1
  }
}

Example:

[
    "+41316784500",
  "+41316784510",
    "+41316784520"
]

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

This resource allows to set a list of phone numbers, which ring simultaneously. The list sent in the body replaces the content of the resource. Empty lists are not allowed to be sent.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: write-voip-simrings.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"array",
  "description":"The list of phone or SIP numbers",
  "minItems": 1,
  "uniqueItems": true,
  "maxItems": 10,
  "items":{  
    "description": "one of the numbers that ring simultaneously. Phonenumbers or SIP Numbers are allowed.",  
    "type": "string",
    "minLength": 1,
    "pattern": "(^(\\+|00|0)[1-9][0-9]{8,15}$)|(^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$)"
  }
}

Example:

[
    "+41316784500",
  "+41316784510",
    "+41316784520"
]

HTTP status code 200

simring configuration successfully completed

Headers

Location: (string)

The configuration for simrings has been successfully done

Example:

https://api.swisscom.com/voice/v1/voip/me/phoneNumbers/0316784534/simrings

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 415

The request has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "415",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "The request entity has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

Used to delete all simRing entries.
A further GET will deliver an empty list.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: write-voip-simrings.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
phoneNumber: (string)
The voip customers phoneNumber to get the information for. The supported phoneNumber formats: 031xxxxxxx, 004131xxxxxxx, +4131xxxxxxx
Example:
```
0316784534
```

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

HTTP status code 200

Deleted simRingNumber for the given Number.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": ["ok"]
    }
  },
  "required": [
    "status"
  ]
}

Example:

{
  "status":"ok"
}

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 415

The request has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "415",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "The request entity has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

/voice/v1/voip/{id}/events/subscriptions get post

The callback with default body template will look as follows:

curl -ik -X POST "http://yourserver.com/call-log-notifications" -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" { "type" : "voip-call-log-change", "target" : "0312223344", "href" : "https://api.swisscom.com/voice/v1/voip/me/phonenumbers/0312223344/calls" }

The Authorization: The header wich was send during the creation of subscription in the callback object.

get

Retrieve all subscriptions for requesting user.

post

Create a new subscription.

Retrieve all subscriptions for requesting user.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: read-voip-eventsubscriptions.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

HTTP status code 200

Returns the phone book

Body

Type: application/json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema",
  "type":"array",
  "minItems":0,
  "uniqueItems":true,
  "items":{  
    "required":[  
      "eventType",
      "subscriptionId",
      "callback",
      "targets",
      "ttl",
      "issuedAt"
    ],
    "properties":{  
      "eventType":{  
        "enum":[  
          "voip-call-log-change",
          "voip-enterprise-phonebook-change"
        ]
      },
      "subscriptionId":{  
        "type":"string"
      },
      
      "callback":{  
        "type":"object",
        "required":[  
          "url"
        ],
        "properties":{  
          "url":{  
            "type":"string"
          },
          "authorization":{  
            "type":"string"
          },
          "bodyTemplate" : {
             "type" : "string"
          }
        }
      },
      "targets":{  
        "type":"array",
        "minItems":1,
        "uniqueItems":true,
        "items":{  
          "required":[  
            "type",
            "value"
          ],
          "properties":{  
            "type":{  
              "enum":[  
                "phoneNumber"
              ]
            },
            "value":{  
              "type":"string"
            }
          }
        }
      },
      "ttl" : {
        "type": "string",
        "description" : "Time To Life"
      },
      "issuedAt" : {
        "type" : "string",
        "description" : "Date and time when the subscription was created"
      }
    }
  }
}

Example:

[  
  {  
    "eventType":"voip-call-log-change",
    "subscriptionId":"6f63ff1e-b75a-11e4-8a00-1681e6b88ec1",
    "callback":{  
      "url":"http://yourserver.com/call-log-notifications",
      "authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
      "bodyTemplate":"{\"type:\":\"<type>\",\"target\":<target>\",\"href\":\"https://api.swisscom.com/voice/v1/voip/me/phoneNumbers/<target>/calls\"}"
    },
    "targets":[  
      {  
        "type":"phoneNumber",
        "value":"0312223344"
      },
      {  
        "type":"phoneNumber",
        "value":"0312223345"
      }
    ],
    "ttl":"3600",
    "issuedAt":"2015-06-11T14:32:51+00:00"
  },
  {  
    "eventType":"voip-enterprise-phonebook-change",
    "subscriptionId":"6f63ff1e-b75a-11e4-8a00-1681e6b88ec2",
    "callback":{  
      "url":"http://yourserver.com/phonebook-notifications",
      "authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
      "bodyTemplate":"{\"type:\":\"<type>\",\"target\":<target>\",\"href\":\"https://api.swisscom.com/voice/v1/voip/me/phoneNumbers/<target>/phonebooks\"}"
    },
    "targets":[  
      {  
        "type":"phoneNumber",
        "value":"0312223344"
      },
      {  
        "type":"phoneNumber",
        "value":"0312223345"
      }
    ],
    "ttl":"3600",
    "issuedAt":"2015-06-11T14:32:51+00:00"
  }
]

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

Create a new subscription.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: write-voip-eventsubscriptions.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema",
  "type":"object",
  "required":[  
    "eventType",
    "callback",
    "targets"
  ],
  "properties":{  
    "eventType":{  
      "enum":[  
        "voip-call-log-change",
        "voip-enterprise-phonebook-change"
      ]
    },
    "callback":{  
      "type":"object",
      "required":[  
        "url"
      ],
      "properties":{  
        "url":{  
          "type":"string"
        },
        "authorization":{  
          "type":"string"
        },
        "bodyTemplate" : {
          "description" : "A valid json body template (encoded)", 
          "type" : "string"
        }
      }
    },
    "targets":{  
      "type":"array",
      "minItems":1,
      "uniqueItems":true,
      "items":{  
        "required":[  
          "type",
          "value"
        ],
        "properties":{  
          "type":{  
            "enum":[  
              "phoneNumber"
            ]
          },
          "value":{  
            "type":"string"
          }
        }
      }
    }
  }
}

Example:

{  
  "eventType":"voip-call-log-change",
  "callback":{  
    "url":"http://yourserver.com/call-log-notifications",
    "authorization":"Basic dXNlcm5hbWU6cGFzc3dvcmQ="
  },
  "targets":[  
    {  
      "type":"phoneNumber",
      "value":"0312223344"
    },
    {  
      "type":"phoneNumber",
      "value":"0312223345"
    }
  ]
}

HTTP status code 201

subscription created

Headers

Location: (string)

The subscription for event was updated.

Example:

https://api.swisscom.com/voice/v1/voip/events/subscriptions/6f63ff1e-e75a-11e4-8a00-1681e6b88ec1

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 415

The request has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "415",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "The request entity has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

/voice/v1/voip/{id}/events/subscriptions/{subscriptionId} get put delete

get

Retrieve a subscription by id.

put

Edit a given subscription.

delete

Used to delete event subscription.

Retrieve a subscription by id.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: read-voip-eventsubscriptions.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
subscriptionId: (string)
The subscription id of the voip subscription to get the information for.
In case the id is unknown the 404 NOT_FOUND will be thrown.

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

HTTP status code 200

Returns the subscription

Body

Type: application/json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema",
  "type":"object",
    "required":[  
      "eventType",
      "subscriptionId",
      "callback",
      "targets",
      "ttl",
      "issuedAt"
    ],
    "properties":{  
      "eventType":{  
        "enum":[  
          "voip-call-log-change",
          "voip-enterprise-phonebook-change"
        ]
      },
      "subscriptionId":{  
        "type":"string"
      },
      "callback":{  
        "type":"object",
        "required":[  
          "url"
        ],
        "properties":{  
          "url":{  
            "type":"string"
          },
          "authorization":{  
            "type":"string"
          },
          "bodyTemplate" : {
             "type" : "string"
          }
        }
      },
      "targets":{  
        "type":"array",
        "minItems":1,
        "uniqueItems":true,
        "items":{  
          "required":[  
            "type",
            "value"
          ],
          "properties":{  
            "type":{  
              "enum":[  
                "phoneNumber"
              ]
            },
            "value":{  
              "type":"string"
            }
          }
        }
      },
      "ttl" : {
        "type": "string",
        "description" : "Time To Life"
      },
      "issuedAt" : {
        "type" : "string",
        "description" : "Date and time when the subscription was created"
      }
    }
  }

Example:

{  
  "eventType":"voip-call-log-change",
  "subscriptionId":"6f63ff1e-b75a-11e4-8a00-1681e6b88ec1",
  "callback":{  
    "url":"http://yourserver.com/call-log-notifications",
    "authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
    "bodyTemplate":"{\"type:\":\"<type>\",\"target\":<target>\",\"href\":\"https://api.swisscom.com/voice/v1/voip/me/phoneNumbers/<target>/calls\"}"
  },
  "targets":[  
    {  
      "type":"phoneNumber",
      "value":"0312223344"
    },
    {  
      "type":"phoneNumber",
      "value":"0312223345"
    }
  ],
  "ttl":"3600",
  "issuedAt":"2015-06-11T14:32:51+00:00"
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

Edit a given subscription.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: write-voip-eventsubscriptions.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
subscriptionId: (string)
The subscription id of the voip subscription to get the information for.
In case the id is unknown the 404 NOT_FOUND will be thrown.

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{  
  "$schema":"http://json-schema.org/draft-04/schema",
  "type":"object",
  "required":[  
    "eventType",
    "callback",
    "targets"
  ],
  "properties":{  
    "eventType":{  
      "enum":[  
        "voip-call-log-change",
        "voip-enterprise-phonebook-change"
      ]
    },
    "callback":{  
      "type":"object",
      "required":[  
        "url"
      ],
      "properties":{  
        "url":{  
          "type":"string"
        },
        "authorization":{  
          "type":"string"
        },
        "bodyTemplate" : {
           "description" : "A valid json body template (encoded)", 
           "type" : "string"
        }
      }
    },
    "targets":{  
      "type":"array",
      "minItems":1,
      "uniqueItems":true,
      "items":{  
        "required":[  
          "type",
          "value"
        ],
        "properties":{  
          "type":{  
            "enum":[  
              "phoneNumber"
            ]
          },
          "value":{  
            "type":"string"
          }
        }
      }
    }
  }
}

Example:

{  
    "eventType":"voip-call-log-change",
    "callback":{  
      "url":"http://yourserver.com/call-log-notifications",
      "authorization":"Basic dXNlcm5hbWU6cGFzc3dvcmQ="
    },
    "targets":[  
      {  
        "type":"phoneNumber",
        "value":"0312223344"
      },
      {  
        "type":"phoneNumber",
        "value":"0312223345"
      }
    ]
  }

HTTP status code 200

Deleted the subscriptions information successfully.

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 415

The request has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "415",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "The request entity has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

Used to delete event subscription.

Secured by OAuth 2.0. Grant types: implicit,authorization_code. Scopes: write-voip-eventsubscriptions.

Request
Response

URI Parameters

id: (string)
The id of the voip account to get the information for. In case the account is authorized (e.g. OAuth) the parameter is "me" and the id is grabbed from the token or session.
In case the id is unknown the 404 NOT_FOUND will be thrown.
subscriptionId: (string)
The subscription id of the voip subscription to get the information for.
In case the id is unknown the 404 NOT_FOUND will be thrown.

Headers

The Authorization OAuth2 Access Token: required (string)
The Authorization OAuth2 access token. The access token, which was retrieved through OAuth2 API, must be set after the Bearer string. The parameter is marked as {access_token}
Example:
```
Authorization: Bearer {access_token}
```
SCS-Request-ID: (string)
The request ID is used to trace individual API requests to the backends and correlate it with the corresponding response.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

HTTP status code 200

Deleted the subscriptions information successfully.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": ["ok"]
    }
  },
  "required": [
    "status"
  ]
}

Example:

{
  "status":"ok"
}

HTTP status code 400

Bad Request. Invalid request.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "400",
  "code": "INVALID_REQUEST",
  "message": "The request could not be understood due to malformed syntax. Correct the request syntax and try again.",
  "detail": ""
}

HTTP status code 401

Unauthorized. No permission to resource or invalid api key.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "401",
  "code": "INVALID_AUTHENTICATION_CREDENTIALS",
  "message": "Authentication credentials missing or incorrect. Check that you are using the correct authentication method and that you have permission to the given resource and your app key is approved.",
  "detail": ""
}

HTTP status code 403

Forbidden. No permission for requested resource.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "403",
  "code": "FORBIDDEN_RESOURCE",
  "message": "The server understood the request, but is refusing to fulfill it. Check that you have permission to the given resource.",
  "detail": ""
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 406

Invalid Header Accept. The provided Accept-type is not equal the accepted. E.g. application/zip instead of application/json.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "406",
  "code": "INVALID_HEADER_ACCEPT",
  "message": "The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. Make sure the request has an Accept header with a media type supported by the API. Check the developer portal for supported media types.",
  "detail": ""
}

HTTP status code 429

Too Many Requests. Quota for this service has been exhausted. Message must contain further details.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "429",
  "code": "EXPIRED_QUOTA",
  "message": "Your quota for this service has been exhausted. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 500

Internal Server Error. Server is misconfigured, or generic error message.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "500",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

HTTP status code 503

Service Unavailable. The server is currently unable to handle the request due to temporary overloading or maintenance. Typically back-end is unavailable.

Headers

SCS-Request-ID: (string)
The request ID is used to trace API requests to the backends and correlate it with the corresponding response. It corresponds to the provided request ID in the request header. It will be generated by the API if non was provided.
Example:
```
SCS-Request-ID: myrequestid-123456789
```

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "503",
  "code": "UNAVAILABLE_SERVICE",
  "message": "The server is currently unable to handle the request due to temporary overloading or maintenance. Try again later or contact support at developer-support@swisscom.com.",
  "detail": ""
}

Voice VoIP API

Voice VoIP APIs

/voice/v1/voip/ get

get /voice/v1/voip/

Query Parameters

HTTP status code 200

HTTP status code 400

Headers

Body

HTTP status code 401

Headers

Body

HTTP status code 403

Headers

Body

HTTP status code 404

Headers

Body

HTTP status code 405

Headers

Body

HTTP status code 406

Headers

Body

HTTP status code 429

Headers

Body

HTTP status code 500

Headers

Body

HTTP status code 503

Headers

Body

/voice/v1/voip/{id}/numbers get

get /voice/v1/voip/{id}/numbers

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 400

Headers

Body

HTTP status code 401

Headers

Body

HTTP status code 403

Headers

Body

HTTP status code 404

Headers

Body

HTTP status code 405

Headers

Body

HTTP status code 406

Headers

Body

HTTP status code 429

Headers

Body

HTTP status code 500

Headers

Body

HTTP status code 503

Headers

Body

/voice/v1/voip/{id}/phoneNumbers/{phoneNumber}/phonebooks get

get /voice/v1/voip/{id}/phoneNumbers/{phoneNumber}/phonebooks

URI Parameters

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Headers

Body

HTTP status code 401

Headers

Body

HTTP status code 403