Skip to main content
GET
/
api
/
flow-execution-contact
/
{id}
Get Flow Execution Contact by Id
curl --request GET \
  --url https://api.hilos.io/api/flow-execution-contact/{id} \
  --header 'Authorization: <api-key>'
{
  "contact": {
    "canonical_phone": "<string>",
    "phone": "<string>",
    "id": "<string>",
    "last_updated_on": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "meta": {},
    "is_deleted": true,
    "created_on": "2023-11-07T05:31:56Z",
    "external_url": "<string>"
  },
  "execution_steps": [
    {
      "step": {
        "flow_version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "step_type": "<string>",
        "next_steps_for_options": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "body_file": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "uploaded_file": "<string>",
          "content_type": "<string>",
          "original_name": "<string>"
        },
        "conditions": [
          {
            "field": "<string>",
            "comparison": "exact",
            "value": "<string>",
            "id": 123
          }
        ],
        "assign_to_users": [
          123
        ],
        "time_windows": [
          {
            "weekday": 0,
            "is_available": true,
            "start_at": "<string>",
            "end_at": "<string>"
          }
        ],
        "assign_to_teams": [
          123
        ],
        "whatsapp_template": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "whatsapp_template_variables": {},
        "next_step_default_idx": 16383,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "next_step_default": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "next_step_alternate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "answer_failed_next_step": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "answer_type": "ANY",
        "body": "<string>",
        "body_type": "audio",
        "body_file_url": "<string>",
        "body_file_type": "URL",
        "answer_validation_message": "<string>",
        "answer_instructions": "<string>",
        "answer_options": [
          "<string>"
        ],
        "answer_phone_default_country": "AF",
        "next_step_alternate_idx": 16383,
        "delay_type": "<string>",
        "delay_until": "2023-11-07T05:31:56Z",
        "action_request_method": "GET",
        "action_request_url": "<string>",
        "action_request_headers": {},
        "action_request_params": {},
        "action_request_body": "<string>",
        "action_test_response_data": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "answer_allow_decimals": true,
        "answer_range_min": "<string>",
        "answer_range_max": "<string>",
        "answer_has_range": true,
        "ordering_idx": 16383,
        "has_options_from_variable": true,
        "option_from_variable_value": "<string>",
        "options_from_variable": "<string>",
        "option_from_variable_title": "<string>",
        "missing_options_message": "<string>",
        "answer_options_render": "BUTTONS",
        "answer_options_render_list_button_title": "<string>",
        "answer_options_render_list_section_title": "<string>",
        "next_steps_for_options_idx": [
          -1
        ],
        "contact_tags": [
          "<string>"
        ],
        "conversation_tags": [
          "<string>"
        ],
        "append_tags": true,
        "max_wait_time_amount": 16383,
        "max_wait_time_unit": "SECOND",
        "has_max_wait_time": true,
        "set_time_window": true,
        "time_window_type": "IN_WORKING_HOURS",
        "has_max_answer_attempts": true,
        "max_answer_attempts": 16383,
        "answer_failed_next_step_idx": 16383,
        "save_contact_answer": false,
        "validate_answer_with_buttons": false,
        "contact_custom_properties": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "contact_first_name": "<string>",
        "contact_last_name": "<string>",
        "contact_email": "<string>",
        "contact_external_url": "<string>",
        "next_flow": "<string>",
        "paths": [
          {
            "conditions": [
              {
                "field": "<string>",
                "comparison": "exact",
                "value": "<string>",
                "id": 123
              }
            ]
          }
        ]
      },
      "messages": [
        {
          "message": {
            "id": "<string>",
            "to_number": "<string>",
            "from_number": "<string>",
            "direction": "<string>",
            "timestamp": "2023-11-07T05:31:56Z",
            "contact": "<string>",
            "status": "new",
            "queued_on": "2023-11-07T05:31:56Z",
            "accepted_on": "2023-11-07T05:31:56Z",
            "sent_on": "2023-11-07T05:31:56Z",
            "delivered_on": "2023-11-07T05:31:56Z",
            "read_on": "2023-11-07T05:31:56Z",
            "failed_on": "2023-11-07T05:31:56Z",
            "provider_id": "<string>",
            "provider_error_code": "<string>",
            "provider_error_message": "<string>",
            "sent_by": {
              "id": 123,
              "first_name": "<string>",
              "last_name": "<string>",
              "email": "jsmith@example.com",
              "profile_image": "<string>",
              "role": "AGENT"
            },
            "is_deleted": true,
            "content": {},
            "whatsapp_template": {
              "name": "<string>",
              "language": "af",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "category": "ACCOUNT_UPDATE",
              "channel": {
                "id": 123,
                "channel_id": "<string>",
                "channel_type": "WHATSAPP",
                "name": "<string>",
                "status": "NEW",
                "created_on": "2023-11-07T05:31:56Z",
                "channel_provider": "META_CLOUD_API",
                "is_sandbox": true
              },
              "components": {},
              "status": "draft",
              "rejected_reason": "<string>",
              "is_deleted": true
            },
            "content_type": "<string>",
            "content_url": "<string>",
            "msg_type": "audio",
            "location": {
              "address": "<string>",
              "latitude": 123,
              "longitude": 123,
              "place_name": "<string>",
              "place_url": "<string>",
              "map_screenshot_url": "<string>"
            },
            "failed_attempts": 123,
            "contacts": [
              {
                "addresses": [
                  {}
                ],
                "emails": [
                  {}
                ],
                "ims": [
                  {}
                ],
                "urls": [
                  "<string>"
                ],
                "name": {},
                "phones": [
                  {}
                ],
                "org": {}
              }
            ],
            "source": "INBOUND",
            "context_message": "<string>",
            "body": "<string>"
          }
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_error_detail": "<string>",
      "has_error": true,
      "expire_on": "2023-11-07T05:31:56Z",
      "status": "WAITING_TO_START",
      "validation_failed_attempts": 16383,
      "execution_result": {},
      "request_data": {},
      "created_on": "2023-11-07T05:31:56Z"
    }
  ],
  "flow_execution": {
    "status": "PROCESSING",
    "execute_for": "FILTERS",
    "created_by": {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "profile_image": "<string>",
      "role": "AGENT"
    },
    "flow": {
      "id": "<string>",
      "name": "<string>",
      "created_by": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com",
        "profile_image": "<string>",
        "role": "AGENT"
      },
      "channel": {
        "id": 123,
        "channel_id": "<string>",
        "channel_type": "WHATSAPP",
        "name": "<string>",
        "status": "NEW",
        "created_on": "2023-11-07T05:31:56Z",
        "channel_provider": "META_CLOUD_API",
        "is_sandbox": true
      },
      "created_on": "2023-11-07T05:31:56Z",
      "is_active": true,
      "status": "DRAFT",
      "is_legacy": true,
      "flow_execution_variables": [
        "<string>"
      ]
    },
    "flow_version": {
      "execution_type": "INBOUND",
      "flow": {
        "id": "<string>",
        "name": "<string>",
        "created_by": {
          "id": 123,
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "jsmith@example.com",
          "profile_image": "<string>",
          "role": "AGENT"
        },
        "channel": {
          "id": 123,
          "channel_id": "<string>",
          "channel_type": "WHATSAPP",
          "name": "<string>",
          "status": "NEW",
          "created_on": "2023-11-07T05:31:56Z",
          "channel_provider": "META_CLOUD_API",
          "is_sandbox": true
        },
        "created_on": "2023-11-07T05:31:56Z",
        "is_active": true,
        "status": "DRAFT",
        "is_legacy": true,
        "flow_execution_variables": [
          "<string>"
        ]
      },
      "is_current_version": true,
      "published_by": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com",
        "profile_image": "<string>",
        "role": "AGENT"
      },
      "last_updated_on": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_name": "<string>",
      "version_description": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "num_contacts": 1073741823,
      "completed": 1073741823,
      "expired": 1073741823,
      "running": 1073741823,
      "canceled": 1073741823,
      "failed": 1073741823,
      "avg_completion_time": "<string>"
    },
    "execution_type": "INBOUND",
    "last_run_on": "<string>",
    "inbound_trigger_with": "ANY_MESSAGE",
    "inbound_start_message": "<string>",
    "inbound_start_message_match_exact": true,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "has_priority": true,
    "flow_execution_variables": {},
    "start_on": "2023-11-07T05:31:56Z",
    "num_contacts": 1073741823,
    "expired": 1073741823,
    "running": 1073741823,
    "completed": 1073741823,
    "canceled": 1073741823,
    "failed": 1073741823,
    "created_on": "2023-11-07T05:31:56Z",
    "avg_completion_time": "<string>",
    "contact_filters": [
      {
        "field": "<string>",
        "comparison": "exact",
        "value": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "READY",
  "created_on": "2023-11-07T05:31:56Z",
  "reason": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
string<uuid>
required

A Flow Execution Contact Id to Retrive.

Response

200 - application/json
​
contact
object
required

The Contact that the Flow Execution Contact is for.

​
execution_steps
object[]
required

The Flow Execution Steps that the Flow Execution Contact has.

​
flow_execution
object
required

Details for the Flow Execution

​
id
string<uuid>
​
status
enum<string>
Available options:
READY,
RUNNING,
COMPLETED,
CANCELED,
PAUSED,
EXPIRED,
FAILED
​
created_on
string<date-time>
​
reason
string | null