スタッフ呼び出し

POST

/staff_calls

curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/staff_calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "storeId": "1", "message": "T1テーブルのお客様がお呼びです" }'

• サンドボックス
• 本番

スタッフを呼び出します。
指定した店舗に登録されているハンディ端末に対してプッシュ通知で任意のメッセージを送信できます。

Authorizations

• AppAccessToken
  waiter.staff-calls:write

Request Body

Media typeapplication/json

object

storeId

required

店舗ID

string

Example

1

title

件名

string

Example

呼び出し

message

required

メッセージ

string

<= 60 characters

Example

T1テーブルのお客様がお呼びです

created

受付日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

Example

2020-09-07T11:45:20+09:00

message

required

Example

T1テーブルのお客様がお呼びです

Responses

200

OK

Media typeapplication/json

object

storeId

店舗ID

string

title

件名

string

message

メッセージ

string

<= 60 characters

created

受付日時[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

Examples

Exampleレスポンス例

{
  "storeId": "1",
  "title": "呼び出し",
  "message": "T1テーブルのお客様がお呼びです",
  "created": "2020-09-07T11:45:20+09:00"
}

400

入力チェックエラーの場合

Media typeapplication/json

object

title

required

string

type

required

string

status

integer

detail

string

Example^generated

{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}