Platform API
Misc

Miscellaneous

This page contains the following information:

  • Timestamps: a 10 or 13 digit record of the time of the occurrence of certain action in a SendBird application.
  • Tokens: opaque strings which are used to point a specific index in a data set.
  • Language support: the language code tables that SendBird's message auto-translation feature currently supports.
  • Deprecated block modes: the block modes that are deprecated but still supported for customers who have been using since before.

Timestamps

The Platform API uses region-independent timestamps to record the time of when certain actions are performed in a SendBird application. The timestamps take the form of Unix Time, mainly in milliseconds, which is a 13-digits number (for example, 1484012373521). A few resources, especially channels, contain timestamps in the form of seconds, which are 10-digits long. The length of the timestamp is specified in the parameter description in the API guide.

Note: Unix time may be checked on most Unix systems by typing date +%s on the command line.


Tokens

When querying a set of data, the Platform API uses tokens to return results in small and continuous chunks. A token is simply an encoded location within a list, and can be passed as a parameter to begin a query from that location.

Like the following, calling a List query with the parameters returns 20 or less items starting from the location encoded in token=YXYWRFBTQlArEUBXWFNeF2p2FEFdUA~~.

Light Color Skin
Copy
?token=YXYWRFBTQlArEUBXWFNeF2p2FEFdUA~~&limit=20

A List query typically returns a next field in the response body. This field contains the next token, which can be used to load the next chunk of results. If this field is blank, the query has reached the end of its results.

Note: If a token is not specified, the query is started from the beginning of the data set.


Language support

SendBird’s message auto-translation feature is powered by Google Cloud Translation API recognition engine and Microsoft Translator engine. The following tables show the languages and codes that each engine supports.

Note: It is by default that Google's Cloud Translation API recognition engine is used for message auto-translation, whereas if your SendBird application has been created before June 26, 2019, Microsoft Translator engine is used.

Google Cloud Translation API recognition engine's language codes
LanguageCodeLanguageCode

Afrikaans

af

Latvian

lv

Albanian

sq

Lithuanian

lt

Amharic

am

Luxembourgish

lb

Arabic

ar

Macedonian

mk

Armenian

hy

Malagasy

mg

Azerbaijani

az

Malay

ms

Basque

eu

Malayalam

ml

Belarusian

be

Maltese

mt

Bengali

bn

Maori

mi

Bosnian

bs

Marathi

mr

Bulgarian

bg

Mongolian

mn

Catalan

ca

Myanmar (Burmese)

my

Cebuano

ceb (ISO-639-2)

Nepali

ne

Chinese (Simplified)

zh-CN or zh (BCP-47)

Norwegian

no

Chinese (Traditional)

zh-TW (BCP-47)

Nyanja (Chichewa)

ny

Corsican

co

Pashto

ps

Croatian

hr

Persian

fa

Czech

cs

Polish

pl

Danish

da

Portuguese (Portugal, Brazil)

pt

Dutch

nl

Punjabi

pa

English

en

Romanian

ro

Esperanto

eo

Russian

ru

Estonian

et

Samoan

sm

Finnish

fi

Scots Gaelic

gd

French

fr

Serbian

sr

Frisian

fy

Sesotho

st

Galician

gl

Shona

sn

Georgian

ka

Sindhi

sd

German

de

Sinhala (Sinhalese)

si

Greek

el

Slovak

sk

Gujarati

gu

Slovenian

sl

Haitian Creole

ht

Somali

so

Hausa

ha

Spanish

es

Hawaiian

haw (ISO-639-2)

Sundanese

su

Hebrew

he or iw

Swahili

sw

Hindi

hi

Swedish

sv

Hmong

hmn (ISO-639-2)

Tagalog (Filipino)

tl

Hungarian

hu

Tajik

tg

Icelandic

is

Tamil

ta

Igbo

ig

Telugu

te

Indonesian

id

Thai

th

Irish

ga

Turkish

tr

Italian

it

Ukrainian

uk

Japanese

ja

Urdu

ur

Javanese

jw

Uzbek

uz

Kannada

kn

Vietnamese

vi

Kazakh

kk

Welsh

cy

Khmer

km

Xhosa

xh

Korean

ko

Yiddish

yi

Kurdish

ku

Yoruba

yo

Kyrgyz

ky

Zulu

zu

Lao

lo

Latin

la

Microsoft Translator engine's language codes
LanguageCodeLanguageCode

Afrikaans

af

Klingon (pIqaD)

tlh-Qaak

Arabic

ar

Korean

ko

Bangla

bn

Latvian

lv

Bosnian (Latin)

bs

Lithuanian

lt

Bulgarian

bg

Malagasy

mg

Cantonese (Traditional)

yeu

Malay

ms

Catalan

ca

Maltese

mt

Chinese Simplified

zh-CHS

Norwegian

no

Chinese Traditional

zh-CHT

Persian

fa

Croatian

hr

Polish

pl

Czech

cs

Portuguese

pt

Danish

da

Querétaro Otomi

otq

Dutch

nl

Romanian

ro

English

en

Russian

ru

Estonian

et

Samoan

sm

Fijian

fj

Serbian (Cyrillic)

sr-Cyrl

Filipino

fil

Serbian (Latin)

sr-Latn

Finnish

fi

Slovak

sk

French

fr

Slovenian

sl

German

de

Spanish

es

Greek

el

Swedish

sv

Haitian Creole

ht

Tahitian

ty

Hebrew

he

Tamil

ta

Hindi

hi

Telugu

te

Hmong Daw

mww

Thai

th

Hungarian

hu

Tongan

to

Icelandic

is

Turkish

tr

Indonesian

id

Ukrainian

uk

Italian

it

Urdu

ur

Japanese

ja

Vietnamese

vi

Kiswahili

sw

Welsh

cy

Klingon

tlh

Yucatec Maya

yua


Deprecated block modes

The following tables describe how the deprecated block modes work. They are only supported for customers who have been using it since before.

How explicit mode works:
Group channelMessagesPush notificationChannel list

1-on-1

New messages from the blocked user will not be delivered to the channel, and an error for sending the message returned to a user. The blocked user is aware of their blocked status.
A user can only see the messages that a blocked user has sent previously before blocking.
(If the blocked user is unblocked, a user can see all the messages except those that were sent during the blocking period.)

A user will not be notified that the blocked user sent a message.

A user's channel list will not be updated and rearranged from the blocked user's messages.

1-on-N (group chat)

All the messages from blocked users are delivered to the channel. You can choose whether or not a user can view which users they have blocked in the UI of the channel.

Messages sent from blocked users will be notified to a user.

A user's channel list will be updated and rearranged from a blocked user's messages.

How silent mode works:
Group channelMessagesPush notificationChannel list

1-on-1

New messages sent from the blocked user will not be delivered to the channel, but are saved and displayed to the blocked user's channel view. The blocked user is not aware of their blocked status.
A user can only see the messages that a blocked user has sent previously before blocking.
(If the blocked user is unblocked, a user can see all the messages except those that were sent during the blocking period.)

A user will not be notified that the blocked user sent a message.

A blocking user's channel list will not be updated and rearranged from the blocked user's messages.

1-on-N (group chat)

All the messages from blocked users are delivered to the channel. You can choose whether or not a user can view which users they have blocked in the UI of the channel.

Messages sent from blocked users will be notified to a blocking user.

A user's channel list will be updated and rearranged from a blocked user's messages.

How classic mode works:
Group channelMessagesPush notificationChannel list

1-on-1

New messages sent from the blocked user will not be delivered to the channel, but are saved and displayed to the blocked user's channel view. A blocked user is not aware of their blocked status.
A user can't see all the messages that the blocked user has sent.

A user will not be notified that the blocked user sent a message.

A user's channel list will not be updated and rearranged from the blocked user's messages.

1-on-N (group chat)

All the messages sent from blocked users are delivered to the channel. A user can't see all messages that blocked users have sent so far.

Messages sent from blocked users will not be notified to a user.

A user's channel list will not be updated and rearranged from a blocked user's messages.