Get chatroom sticker pack

GET 
/bv/chatroom/v1/chatrooms/stickerpacks/:id

Retrieve a specified sticker pack which is enabled in the chatroom. Authorization requires the chatroom token.

Request

Path Parameters

id stringrequired

Required. The unique id of the sticker pack.

Header Parameters

authorization string

This API should be invoked with the chatroom token.

Responses

200

A successful response.

application/json

Schema

Schema

sticker_pack object

id string

Output only. The uuid of the sticker pack.

name stringrequired

Required. The name of the sticker pack.

default boolean

Optional. Immutable. Indicates it'll be or it was a default sticker pack that can not be modified or deleted. Default: false.

count int32

Output only. Indicates the total count of the stickers in the sticker pack.

cover_image object

Output only. The cover image of the sticker pack.

id string

Output only. The unique id of the image.

name string

Output only. The name of the image.

size_in_bytes int64

Output only. The size of image in bytes.

format string

Possible values: [IMAGE_FORMAT_PNG, IMAGE_FORMAT_JPEG, IMAGE_FORMAT_GIF]

Output only. The format of the image.

thumbnails object[]

Output only.

Array [

uri string

Output only. Indicates the URI of the image that the browser could be rendered.

width int32

Output only. Indicates the width of the image.

height int32

Output only. Indicates the height of the image.

]

created_at date-time

Output only. Indicates the time that the sticker pack created.

updated_at date-time

Output only. Indicates the time that the sticker pack last updated.

stickers object[]
Array [
id string
Output only. The uuid of the sticker.
name string
Optional. The name of the sticker.
image objectrequired
Required.
id string
Output only. The unique id of the image.
name stringrequired
Required. The name of the image.
size_in_bytes int64required
Required. Immutable. The size of image in bytes.
format string
Possible values: [IMAGE_FORMAT_PNG, IMAGE_FORMAT_JPEG, IMAGE_FORMAT_GIF]
Output only. The format of the image.
thumbnails object[]
Output only.
Array [
uri string
Output only. Indicates the URI of the image that the browser could be rendered.
width int32
Output only. Indicates the width of the image.
height int32
Output only. Indicates the height of the image.
]
created_at date-time
Output only. Indicates the time that the sticker pack created.
updated_at date-time
Output only. Indicates the time that the sticker pack last updated.
]

Example (from schema)

{
  "sticker_pack": {
    "id": "string",
    "name": "string",
    "default": true,
    "count": 0,
    "cover_image": {
      "id": "string",
      "name": "string",
      "size_in_bytes": "string",
      "format": "IMAGE_FORMAT_PNG",
      "thumbnails": [
        {
          "uri": "string",
          "width": 0,
          "height": 0
        }
      ]
    },
    "created_at": "2024-05-20T05:01:36.477Z",
    "updated_at": "2024-05-20T05:01:36.477Z"
  },
  "stickers": [
    {
      "id": "string",
      "name": "string",
      "image": {
        "id": "string",
        "name": "string",
        "size_in_bytes": "string",
        "format": "IMAGE_FORMAT_PNG",
        "thumbnails": [
          {
            "uri": "string",
            "width": 0,
            "height": 0
          }
        ]
      },
      "created_at": "2024-05-20T05:01:36.477Z",
      "updated_at": "2024-05-20T05:01:36.477Z"
    }
  ]
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

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

Loading...