コンテンツにスキップ
AchaduDevelopers
Developers/API/journey_execute

ランニングの旅

承認された連絡先または会話の明示的な実行を開始します。

POST/journeys/{id}/executejourneys:write
行動

リクエストは入力を検証し、コマンドを永続化し、初期状態を返します。専用キューで実行を継続できます。

効果

データベースでの確認後に、非同期作業および Webhook イベントを作成できます。

繰り返し

ネットワーク障害が発生した場合は、リソースの状態を確認してから再試行してください。バックオフとジッターを使用して 429 と 5xx のみを自動的にやり直します。

リクエスト

idstring · pathリソース識別子。minLength 2 · maxLength 100必須
contact_idstring · bodyターゲットの連絡先。オプション
conversation_idstring · bodyターゲットの話。オプション
contextobject · bodyコンテキストに依存しない実行。オプション
AuthorizationBearer ach_live_...
Acceptapplication/json
範囲journeys:write

実行ファイルの例

curl
curl -X POST 'https://achadu.com/api/v1/journeys/resource_id/execute' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "contact_id": "string",
  "conversation_id": "string",
  "context": "string"
}'

応答とエラー

すべての応答には request_id が含まれます。リストにはページネーションが追加されます。可変リソースは、操作後に永続化された状態を返します。

200 application/json
{
  "data": {
    "id": "jrn_01J...",
    "name": "Recover interest",
    "trigger": "conversation.updated",
    "blocks": [],
    "active": 1,
    "executions": 42
  },
  "request_id": "req_01J..."
}
200操作が完了しました。
400Invalid parameter, body or transition.
401キーが見つからない、無効、期限切れ、または取り消されています。
402アカウント プランでは、このインターフェイスはリリースされません。
403A chave precisa do escopo journeys:write.
404このアカウントには機能が存在しません。
409The current state prevents this operation.
413The JSON body exceeds 128 KB.
4291 分あたり 120 リクエストのウィンドウを超えました。