Get SMS Provider

Get a specific SMS provider by its ID.

Path Parameters

• id string required

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

Schema

• config object

  details object

  sequence uint64

  on read: the sequence of the last event reduced by the projection

  on manipulation: the timestamp of the event(s) added by the manipulation

  creationDate date-time

  on read: the timestamp of the first event of the object

  on create: the timestamp of the event(s) added by the manipulation

  changeDate date-time

  on read: the timestamp of the last event reduced by the projection

  on manipulation: the

  resourceOwner resource_owner is the organization an object belongs to

  id string

  state string

  Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED, SMS_PROVIDER_CONFIG_ACTIVE, SMS_PROVIDER_CONFIG_INACTIVE]

  Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED

  twilio object

  sid string

  senderNumber string

{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "resourceOwner": "69629023906488334"
    },
    "id": "string",
    "state": "SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED",
    "twilio": {
      "sid": "string",
      "senderNumber": "string"
    }
  }
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• config object

  details object

  sequence uint64

  on read: the sequence of the last event reduced by the projection

  on manipulation: the timestamp of the event(s) added by the manipulation

  creationDate date-time

  on read: the timestamp of the first event of the object

  on create: the timestamp of the event(s) added by the manipulation

  changeDate date-time

  on read: the timestamp of the last event reduced by the projection

  on manipulation: the

  resourceOwner resource_owner is the organization an object belongs to

  id string

  state string

  Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED, SMS_PROVIDER_CONFIG_ACTIVE, SMS_PROVIDER_CONFIG_INACTIVE]

  Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED

  twilio object

  sid string

  senderNumber string

{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "resourceOwner": "69629023906488334"
    },
    "id": "string",
    "state": "SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED",
    "twilio": {
      "sid": "string",
      "senderNumber": "string"
    }
  }
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• config object

  details object

  sequence uint64

  on read: the sequence of the last event reduced by the projection

  on manipulation: the timestamp of the event(s) added by the manipulation

  creationDate date-time

  on read: the timestamp of the first event of the object

  on create: the timestamp of the event(s) added by the manipulation

  changeDate date-time

  on read: the timestamp of the last event reduced by the projection

  on manipulation: the

  resourceOwner resource_owner is the organization an object belongs to

  id string

  state string

  Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED, SMS_PROVIDER_CONFIG_ACTIVE, SMS_PROVIDER_CONFIG_INACTIVE]

  Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED

  twilio object

  sid string

  senderNumber string

{
  "config": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "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.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

Returned when the resource does not exist.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

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

Loading...