Messaging SMS API

Messaging APIs

Messaging cluster

/messaging/v1/sms/ post

post

Send an SMS

Request
Response

Headers

Your apiKey: (string)
Alternative for your apiKey: (string)

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema",
    "type": "object",
    "required": [
      "to", "text"
    ],
    "properties": {
        "from": {
            "description": "Sender string",
            "type": "string"
        },
        "to": {
            "description": "Recipient number. A valid number starts with 0, 00 or + and must contain 7 to 15 digits. Local numbers (prefix 0) are handled with international code +41 by default.", 
            "type": "string"
        },
        "text": {
            "description": "Appears as text in SMS.",
            "type": "string"
        },
        "callbackUrl": {
            "description": "A valid callback URL for delivery notification. The notification call will be send (PUT method with the header.location which contains messageID) for each SMS status change",
            "type": "string"
        }
    }
}

Example:

{
  "from" : "Web Shop",
  "to" : "+49792234567",
  "text" : "Thank you for your order. Your order will be shipped at 15:00 today."
}

HTTP status code 201

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

/messaging/v1/sms/{messageId} get

get

Get Status information

Request
Response

URI Parameters

messageId: (string)
Example:
```
2848ede0-b2ea-40cf-cd18-71da36318bb1
```

Headers

Your apiKey: (string)
Alternative for your apiKey: (string)

HTTP status code 200

Body

Type: application/json

Schema:

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

Example:

{
  "messageId":"0001",
  "status":"201",
  "description":"Delivered with delivery confirmation"
}

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

Messaging SMS API

Messaging APIs

/messaging/v1/sms/ post

post /messaging/v1/sms/

Headers

Body

HTTP status code 201

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

/messaging/v1/sms/{messageId} get

get /messaging/v1/sms/{messageId}

URI Parameters

Headers

HTTP status code 200

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 429

Headers

Body

HTTP status code 500

Headers

Body

HTTP status code 503

Headers

Body