{"info":{"_postman_id":"d2d2f4dc-e999-459a-8b5f-bb4e81c07f86","name":"AlleyPin/LinePnpSms","description":"

Flow Chart

\n\n\n

Sequence Diagram

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6295887","collectionId":"d2d2f4dc-e999-459a-8b5f-bb4e81c07f86","publishedId":"2s9YC32ZkC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"044b94"},"publishDate":"2023-11-03T09:12:42.000Z"},"item":[{"name":"api key login","id":"a983b2e0-745c-43ce-ae26-b440f5032f87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"apiKey\":\"ZVUhQGdbAL09xKblRTrXITn2CxvLI0Q6x7imnfooItPduewovruZf8yjEblChER5qssGYhFzMdudxZ35Knldm0X31njzC3xPZ7OYIQtRtggUivfb0P1YZgUizw8OCZvd\", // AlleyPin提供\n \"serviceStoreID\":\"3731020440\" // AlleyPin提供\n}","options":{"raw":{"language":"json"}}},"url":"{{openapiHost}}/v1/auth/exchangeToken","description":"

獲取權杖

\n\n","urlObject":{"path":["v1","auth","exchangeToken"],"host":["{{openapiHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a983b2e0-745c-43ce-ae26-b440f5032f87"},{"name":"push message","id":"c1f8186b-1210-4499-8fa2-50d4750957ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"x-vendor-name","value":"DrCooper","type":"text"},{"key":"x-client-id","value":"8d530230-1806-11eb-92e9-113a8ce47f95","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to\": \"0928767887\",\n \"toggle\": {\n \"line\": true,\n \"lon\": true,\n \"sms\": true\n },\n \"contentFormat\": \"deliveryArrivalNotify\",\n \"replaceArgs\": {\n \"{{QRcode}}\": \"https://xmclinic.site/?ks_qr_link=17639-1\",\n \"{{altText}}\": \"疫苗領用通知\",\n \"{{arrivalButtonLabel1}}\": \"預約掛號\",\n \"{{arrivalButtonLabel2}}\": \"查詢訂單\",\n \"{{arrivalButtonUri1}}\": \"https://lin.ee/bFM8TFv\",\n \"{{arrivalButtonUri2}}\": \"https://xmclinic.site/checkout/order-received/17639/?key=wc_order_QRe1LgaQzPC1F\",\n \"{{clientNameTitle}}\": \"領用姓名\",\n \"{{clientName}}\": \"翔平測試\",\n \"{{description}}\": \"親愛的朋友您好，您的預訂項目已在診所恭候，您可以先預約掛號前往時段，並請出示本票券以供核對，若己完成請忽略此通知，謝謝您。\",\n \"{{name}}\": \"翔平測試\",\n \"{{orderItemIDTitle}}\": \"票券編號\",\n \"{{orderItemID}}\": \"17639-1\",\n \"{{orderItemTitle}}\": \"領用項目\",\n \"{{orderItem}}\": \"東洋細胞型流感疫苗\",\n \"{{orderTimeTitle}}\": \"預訂時間\",\n \"{{orderTime}}\": \"2024-12-09 19:57:02\",\n \"{{title}}\": \"領用通知\"\n },\n \"callbackUrl\": \"https://callbackURL\"\n}","options":{"raw":{"language":"json"}}},"url":"{{openapiHost}}/v1/message/push","description":"

發送訊息

\n\n

Headers：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
headervalue
AuthorizationBearer {accessToken}
Content-Typeapplication/json
\n

Body：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyType說明
tostring醫點通客戶僅需輸入手機號碼即可判斷是否透過line 或 pnp 或sms發送，若非使用醫點通服務並預期發送LINE訊息，請輸入LINEID。
channelIDnumber醫點通客戶LINE channel ID
clientIDstring醫點通客戶ID
toggleobject用戶可自行決定發送管道，發送順序為 LINE -> PNP -> SMS
contentFormatstring目前有以下發送內容，欲增加內容請從翔評互動OA提出申請
replaceArgsobject訊息內容中的動態參數
callbackUrlstring如果webhook由翔評接收，發送訊息3分鐘後，會將發送結果送至此url，詳細的request body請參照『callback message result』api
\n

toggle物件說明：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyType說明
lineboolean是否發送LINE訊息
lonboolean是否發送PNP訊息
smsboolean是否發送SMS訊息
\n

contentFormat發送內容：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
內容名稱Value
官網加入完成通知registrationCompleteNotify
付款完成通知paymentCompleteNotify
到貨通知deliveryArrivalNotify
退款通知refundCompleteNotify
\n

replaceArgs物件說明：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
參數名稱Type說明
{{color}}string顏色代碼
{{joinedAt}}string加入日期
{{clientName}}string客戶名稱
{{btnlink}}string按鈕連結
{{btnTitle}}string按鈕標題
\n

Request Body Example：

\n
{\n    \"to\": \"0934455023\",  \n    \"clientID\": \"d51ff4b0-d038-11ec-\", \n    \"toggle\": { \n        \"line\": false,\n        \"lon\": false,\n        \"sms\": false\n    },\n    \"contentFormat\": \"registrationCompleteNotify\", \n    \"replaceArgs\": {\n        \"{{color}}\": \"#24ba92\",\n        \"{{joinedAt}}\": \"2023-09-12 08:42:30\",\n        \"{{clientName}}\": \"新明診所\",\n        \"{{btnlink}}\": \"https://example.com\",\n        \"{{btnTitle}}\": \"個人設定\"\n    },\n    \"callbackUrl\":\"https://callbackUrl?orderID=123\"\n}\n\n
\n

Response：

\n

Status Code：200

\n
{\n   \"id\": \"b97c9f25-500f-4d30-9923-e1846cc08c0b\"\n}\n\n
\n","urlObject":{"path":["v1","message","push"],"host":["{{openapiHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1f8186b-1210-4499-8fa2-50d4750957ff"},{"name":"push message text only","id":"74e8647c-95e8-4803-b69f-510ee026c405","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"x-vendor-name","value":"DrCooper","type":"text"},{"key":"x-client-id","value":"8d530230-1806-11eb-92e9-113a8ce47f95","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to\": \"0975413060\",\n \"toggle\": {\n \"line\": true,\n \"sms\": true\n },\n \"contentFormat\": \"textOnly\",\n \"replaceArgs\": {\n \"{{content}}\": \"2222\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{openapiHost}}/v1/message/push","description":"

發送訊息

\n\n

Headers：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
headervalue
AuthorizationBearer {accessToken}
Content-Typeapplication/json
\n

Body：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyType說明
tostring醫點通客戶僅需輸入手機號碼即可判斷是否透過line 或 pnp 或sms發送，若非使用醫點通服務並預期發送LINE訊息，請輸入LINEID。
channelIDnumber醫點通客戶LINE channel ID
clientIDstring醫點通客戶ID
toggleobject用戶可自行決定發送管道，發送順序為 LINE -> PNP -> SMS
contentFormatstring目前有以下發送內容，欲增加內容請從翔評互動OA提出申請
replaceArgsobject訊息內容中的動態參數
callbackUrlstring如果webhook由翔評接收，發送訊息3分鐘後，會將發送結果送至此url，詳細的request body請參照『callback message result』api
\n

toggle物件說明：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyType說明
lineboolean是否發送LINE訊息
lonboolean是否發送PNP訊息
smsboolean是否發送SMS訊息
\n

contentFormat發送內容：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
內容名稱Value
官網加入完成通知registrationCompleteNotify
付款完成通知paymentCompleteNotify
到貨通知deliveryArrivalNotify
退款通知refundCompleteNotify
\n

replaceArgs物件說明：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
參數名稱Type說明
{{color}}string顏色代碼
{{joinedAt}}string加入日期
{{clientName}}string客戶名稱
{{btnlink}}string按鈕連結
{{btnTitle}}string按鈕標題
\n

Request Body Example：

\n
{\n    \"to\": \"0934455023\",  \n    \"clientID\": \"d51ff4b0-d038-11ec-\", \n    \"toggle\": { \n        \"line\": false,\n        \"lon\": false,\n        \"sms\": false\n    },\n    \"contentFormat\": \"registrationCompleteNotify\", \n    \"replaceArgs\": {\n        \"{{color}}\": \"#24ba92\",\n        \"{{joinedAt}}\": \"2023-09-12 08:42:30\",\n        \"{{clientName}}\": \"新明診所\",\n        \"{{btnlink}}\": \"https://example.com\",\n        \"{{btnTitle}}\": \"個人設定\"\n    },\n    \"callbackUrl\":\"https://callbackUrl?orderID=123\"\n}\n\n
\n

Response：

\n

Status Code：200

\n
{\n   \"id\": \"b97c9f25-500f-4d30-9923-e1846cc08c0b\"\n}\n\n
\n","urlObject":{"path":["v1","message","push"],"host":["{{openapiHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"74e8647c-95e8-4803-b69f-510ee026c405"},{"name":"message check","id":"42a582b5-bd6d-4922-9545-4053f8ed6ea8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{acccessToken}}","type":"text"}],"url":"{{openapiHost}}/v1/message/37c842ee-8a40-4d58-8d19-004788dced97","description":"

取得訊息資訊

\n
    \n
  • Method：GET
    • \n
  • URL：
      \n
    • 正式區：https://openapi.alleypinapis.com/v1/message/:id
      • \n
    • 測試區：https://openapi-stg.alleypinapis.com/v1/message/:id
      • \n
    \n
    • \n
\n

Headers：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
headervalue
AuthorizationBearer {accessToken}
Content-Typeapplication/json
\n

Path Variables

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
keyvalue
idmessage ID
\n

Response：

\n

Status Code：200

\n
{\n   \"id\": \"b97c9f25-500f-4d30-9923-e1846cc08c0b\",\n   \"to\": \"U39705f645e861bcb64132a2ad40b86d3\",\n   \"deliveryAt\": \"2023-12-14 11:09:44.77007+80\",\n   \"sendingType\": \"line\",\n   \"status\": \"done\",\n   \"errorMessage\": \"\"\n}\n\n
\n

response欄位說明

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
keyvalue
idmessage ID
tolineID 或 手機號碼
deliveryAt送達時間，但是sms的情境不會有值
sendingType有line 或 lon兩種value
statussuccess: 發送完成, failed:發送失敗, inProgress: 處理中
errorMessage錯誤訊息
\n
","urlObject":{"path":["v1","message","37c842ee-8a40-4d58-8d19-004788dced97"],"host":["{{openapiHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42a582b5-bd6d-4922-9545-4053f8ed6ea8"},{"name":"update message","id":"72be8f71-6c7a-405a-b2fd-43e47ba0bd09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{acccessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pnpStatus\":\"success\"\n}","options":{"raw":{"language":"json"}}},"url":"{{openapiHost}}/v1/message/{id}","description":"

更新訊息發送狀態

\n
    \n

  • Method：PUT

    \n
    • \n

  • URL：

    \n
      \n

    • 正式區：https://openapi.alleypinapis.com/v1/message/:id

      \n
      • \n

    • 測試區：https://openapi-stg.alleypinapis.com/v1/message/:id

      \n
      • \n
    \n
    • \n
\n

Headers：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
headervalue
AuthorizationBearer {accessToken}
Content-Typeapplication/json
\n

Path Variables

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
keyvalue
idmessage ID
\n

Body：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyType說明
pnpStatusstring只接受以下兩種狀態
success
failed
errorMessagestring若上方pnpStatus為failed,再帶入即可(非必填)
\n

Response：

\n

Status Code：204 更新成功

\n","urlObject":{"path":["v1","message","{id}"],"host":["{{openapiHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"72be8f71-6c7a-405a-b2fd-43e47ba0bd09"},{"name":"callback message result","id":"f78b046e-c186-4b7b-9d39-8c6220af7f88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\":\"8e163b59-9dc0-4c49-9313-93450cdb9c86\",\n \"status\":\"success\",\n \"type\":\"line\"\n}","options":{"raw":{"language":"json"}}},"url":"{{callbackUrl}}","description":"

callback 訊息發送結果回傳

\n

若webhook 是由翔評端處理，會在收到『push message』request後發送此request至callbackUrl，若最後發送方式為lon或sms，則會延遲3分鐘才收到request

\n
    \n

  • Method：POST

    \n
    • \n

  • URL：{{callbackUrl}}

    \n
    • \n
\n

Headers：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
headervalue
Content-Typeapplication/json
\n

Body：

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyType說明
idstringpush message api 回傳的id
statusstring發送狀態會有三種value： success/inProcess/failed，但inProcess應該不會在此種情境出現
typestring該訊息最終發送的方式，可能會有以下三種value：line/lon/sms
\n

Request Body Example：

\n
{\n    \"id\":\"8e163b59-9dc0-4c49-9313-93450cdb9c86\",\n    \"status\":\"success\",\n    \"type\":\"line\"\n}\n\n
\n

Response：

\n

Status Code：200

\n","urlObject":{"host":["{{callbackUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f78b046e-c186-4b7b-9d39-8c6220af7f88"}]}