Voice Mail API

https://api.swisscom.com/

Voice Mail APIs

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

get

get

For OAuth Authorization Code Checks that the given MSISDN is connected to the BlueAditAccountNumber (on the token). For OAuth Client Credentials any Swisscom MSISDN can be requested. If this check is positive, it returns a list of all recent voicemail messages.

For OAuth Authorization Code Checks that the given MSISDN is connected to the BlueAditAccountNumber (on the token). For OAuth Client Credentials any Swisscom MSISDN can be requested. If this check is positive, it returns a list of all recent voicemail messages.

Secured by OAuth 2.0. Grant types: client_credentials,authorization_code. Scopes: read-voicemail-messages.

URI Parameters

  • phonenumber: (string)

    The phone-number, which is connected to the voicemail The accepted formats of the phonenumber are (no spaces, no special characters): 079xxxxxxx 004179xxxxxxx +4179xxxxxxx

    Example:

    0041316784534

Headers

  • Authorization: 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:

    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:

    myrequestid-123456789

HTTP status code 200

List of all recent voicemail messages.

Body

Type: application/json

Schema:

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"array",
  "minItems":0,
  "items":{  
    "type":"object",
    "properties":{  
      "id":{  
        "type":"integer",
        "minLength":1
      },
      "links":{  
        "type":"array",
        "items":{  
          "type":"object",
          "properties":{  
            "rel":{  
              "type":"string",
              "minLength":1,
              "description":"The name of the referenced resource."
            },
            "href":{  
              "type":"string",
              "minLength":1,
              "description":"URL of the message in mp3 or wave format",
              "example":"https://api.swisscom.com/voice/v1/voicemail/+41791231234/messages/56098978769"
            }
          },
          "required":[  
            "rel",
            "href"
          ]
        }
      },
      "sender":{  
        "type":"string",
        "description":"sender telephone number, ideally in the +41 format"
      },
      "status":{  
        "enum":[  
          "new",
          "read",
          "saved"
        ],
        "description":"status of the message"
      },
      "messageLength":{  
        "type":"number",
        "description":"length of the recording in seconds"
      },
      "contentType":{  
        "type":"string",
        "description":"media Type of the recording"
      },
      "depositDate":{  
        "type":"string",
        "description":"date/time when the message was left on the voicemail"
      },
      "expirationDate":{  
        "type":"string",
        "description":"date/time when the message will be archived"
      }
    },
    "required":[  
      "sender"
    ]
  }
}

Example:

[  
  {  
    "id":56098978769,
    "links":[  
      {  
        "rel":"messageId",
        "href":"https://api.swisscom.com/voice/v1/voicemail/+41791231234/messages/56098978769"
      }
    ],
    "sender":"+41234095678",
    "status":"read",
    "messageLength":120,
    "contentType":"audio/wav",
    "depositDate":"2015-10-20T11:08:55Z",
    "expirationDate":"2015-10-21T11:09:57Z"
  },
  {  
    "id":56098978700,
    "links":[  
      {  
        "rel":"messageId",
        "href":"https://api.swisscom.com/voice/v1/voicemail/+41791231234/messages/56098978700"
      }
    ],
    "sender":"+41234095679",
    "status":"new",
    "messageLength":90,
    "contentType":"audio/mpeg",
    "depositDate":"2015-10-21T11:08:55Z",
    "expirationDate":"2015-10-22T11:09:57Z"
  }
]

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:

    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:

    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:

    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:

    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:

    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:

    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:

    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": ""
}

get delete patch

get

Returns a specific voicemail message with a given messageId.

delete

Deletes a specific voicemail message.

patch

Changes the status (read, new, saved) of a specific voicemail message.

Returns a specific voicemail message with a given messageId.

Secured by OAuth 2.0. Grant types: client_credentials,authorization_code. Scopes: read-voicemail-messages.

URI Parameters

  • phonenumber: (string)

    The phone-number, which is connected to the voicemail The accepted formats of the phonenumber are (no spaces, no special characters): 079xxxxxxx 004179xxxxxxx +4179xxxxxxx

    Example:

    0041316784534
  • messageId: (string)

    The identifier of the voicemail message.

    Example:

    1234567890

Headers

  • Accept: (string)


    Possible value:

    • application/json: the message details will be return
    • any other (e.g: audio/wav,audio/mpeg): the content of the message (byte array) will be return. The type has to match content-type based on

    Example:

    audio/wav

HTTP status code 200

Specific combox message.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type":"object",
    "properties": {
        "sender": {
            "type": "string",
            "description": "sender telephone number"
        },
        "status": {
            "enum":[  
      			"new", "read", "saved"
    		],
            "description": "status of the message"
        },
        "messageLength": {
            "type": "number",
            "description": "length of the recording in seconds"
        },
        "contentType": {
            "type": "string",
            "description": "media Type of the recording"
        },
        "depositDate": {
            "type": "string",
            "description": "date/time when the message was left on the combox"
        },
        "expirationDate": {
            "type": "string",
            "description": "date/time when the message will be archived"
        }
    },
    "required": [
        "sender"
    ]      
}

Example:

{
	"sender": "+41234095679",
	"status": "new",
	"messageLength": 90,
	"contentType": "audio/wave",
	"depositDate":"2015-10-21T11:08:55Z",
	"expirationDate":"2015-10-22T11:09:57Z"
}

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:

    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:

    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:

    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:

    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:

    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:

    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:

    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": ""
}

Deletes a specific voicemail message.

Secured by OAuth 2.0. Grant types: client_credentials,authorization_code. Scopes: write-voicemail-messages.

URI Parameters

  • phonenumber: (string)

    The phone-number, which is connected to the voicemail The accepted formats of the phonenumber are (no spaces, no special characters): 079xxxxxxx 004179xxxxxxx +4179xxxxxxx

    Example:

    0041316784534
  • messageId: (string)

    The identifier of the voicemail message.

    Example:

    1234567890

HTTP status code 200

Specific voicemail message with given messageId deleted.

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:

    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:

    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:

    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:

    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:

    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:

    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:

    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": ""
}

Changes the status (read, new, saved) of a specific voicemail message.

Secured by OAuth 2.0. Grant types: client_credentials,authorization_code. Scopes: write-voicemail-messages.

URI Parameters

  • phonenumber: (string)

    The phone-number, which is connected to the voicemail The accepted formats of the phonenumber are (no spaces, no special characters): 079xxxxxxx 004179xxxxxxx +4179xxxxxxx

    Example:

    0041316784534
  • messageId: (string)

    The identifier of the voicemail message.

    Example:

    1234567890

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type":"object",
    "properties": {
        "status": {
            "enum": [  
      			"new", "read", "saved"
    		],
            "description": "status of the message"
        }
    },
    "required": [
        "status"
    ]      
}

Example:

{
	"status": "read"
}

HTTP status code 200

Change status of specific combox message with given messageId.

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:

    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:

    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:

    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:

    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:

    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:

    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:

    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": ""
}