List SMS Providers​
Returns a list of configured SMS providers.
Request Body required
query object
Object unspecific list filters like offset, limit and asc/desc.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Request Body required
query object
Object unspecific list filters like offset, limit and asc/desc.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Request Body required
query object
Object unspecific list filters like offset, limit and asc/desc.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
- 200
- 403
- 404
- default
A successful response.
Schema
- Array [
- ]
details object
the last time the view got updated
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
, SMS_PROVIDER_CONFIG_ACTIVE
, SMS_PROVIDER_CONFIG_INACTIVE
]
Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
twilio object
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:38.859Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.859Z",
"changeDate": "2024-06-13T06:44:38.859Z",
"resourceOwner": "69629023906488334"
},
"id": "string",
"state": "SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED",
"twilio": {
"sid": "string",
"senderNumber": "string"
}
}
]
}
Schema
- Array [
- ]
details object
the last time the view got updated
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
, SMS_PROVIDER_CONFIG_ACTIVE
, SMS_PROVIDER_CONFIG_INACTIVE
]
Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
twilio object
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:38.859Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.859Z",
"changeDate": "2024-06-13T06:44:38.859Z",
"resourceOwner": "69629023906488334"
},
"id": "string",
"state": "SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED",
"twilio": {
"sid": "string",
"senderNumber": "string"
}
}
]
}
Schema
- Array [
- ]
details object
the last time the view got updated
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
, SMS_PROVIDER_CONFIG_ACTIVE
, SMS_PROVIDER_CONFIG_INACTIVE
]
Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
twilio object
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:38.859Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.860Z",
"changeDate": "2024-06-13T06:44:38.860Z",
"resourceOwner": "69629023906488334"
},
"id": "string",
"state": "SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED",
"twilio": {
"sid": "string",
"senderNumber": "string"
}
}
]
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}