Get SMS Provider

GET 
https://$CUSTOM-DOMAIN/admin/v1/sms/:id

Get a specific SMS provider by its ID.

Request

Path Parameters

id stringrequired

Responses

200

A successful response.

application/json

Schema

Schema

config object
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
idstring
statestring
Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED, SMS_PROVIDER_CONFIG_ACTIVE, SMS_PROVIDER_CONFIG_INACTIVE]
Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
descriptionstring
twilio object
sidstring
senderNumberstring
verifyServiceSidstring
http object
endpointstring

Example (auto)

{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "changeDate": "2024-07-29T15:51:28.071Z",
      "resourceOwner": "69629023906488334"
    },
    "id": "string",
    "state": "SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED",
    "description": "string",
    "twilio": {
      "sid": "string",
      "senderNumber": "string",
      "verifyServiceSid": "string"
    },
    "http": {
      "endpoint": "string"
    }
  }
}

application/grpc

Schema

Schema

config object
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
idstring
statestring
Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED, SMS_PROVIDER_CONFIG_ACTIVE, SMS_PROVIDER_CONFIG_INACTIVE]
Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
descriptionstring
twilio object
sidstring
senderNumberstring
verifyServiceSidstring
http object
endpointstring

Example (auto)

{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "changeDate": "2024-07-29T15:51:28.071Z",
      "resourceOwner": "69629023906488334"
    },
    "id": "string",
    "state": "SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED",
    "description": "string",
    "twilio": {
      "sid": "string",
      "senderNumber": "string",
      "verifyServiceSid": "string"
    },
    "http": {
      "endpoint": "string"
    }
  }
}

application/grpc-web+proto

Schema

Schema

config object
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
idstring
statestring
Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED, SMS_PROVIDER_CONFIG_ACTIVE, SMS_PROVIDER_CONFIG_INACTIVE]
Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED
descriptionstring
twilio object
sidstring
senderNumberstring
verifyServiceSidstring
http object
endpointstring

Example (auto)

{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "changeDate": "2024-07-29T15:51:28.071Z",
      "resourceOwner": "69629023906488334"
    },
    "id": "string",
    "state": "SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED",
    "description": "string",
    "twilio": {
      "sid": "string",
      "senderNumber": "string",
      "verifyServiceSid": "string"
    },
    "http": {
      "endpoint": "string"
    }
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Authorization: oauth2

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Auth

Bearer Token

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!