Docs Connect Samples

Samples

Distribution: SINGLE

One agent in leg_a is called. Exactly one A-leg is permitted.

Request

JSON
{
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "whisper": "A potential customer has shown interest in your Citi Golf",
  "recorded": true,
  "reference": "lead-ref-2024-001",
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "call_distribution": "SINGLE",
  "connect_type": "LEAD_CONNECT",
  "leg_a": [
    {
      "number": "27821234567",
      "name": "Jane Smith",
      "reference": "agent123"
    }
  ],
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe"
    }
  ]
}

Response — 201 Created

JSON
{
  "url": "https://next.logimeter.com/v1/connect/1ab5579f-88af-4873-9433-b595a8d5738d/",
  "uuid": "1ab5579f-88af-4873-9433-b595a8d5738d",
  "reference": "lead-ref-2024-001",
  "create_stamp": "2024-08-08T09:56:23.915931Z",
  "modify_stamp": "2024-08-08T09:56:23.915931Z",
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "whisper": "A potential customer has shown interest in your Citi Golf",
  "recorded": true,
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "partner": {
    "name": "your-partner"
  },
  "call_distribution": "SINGLE",
  "connect_type": "LEAD_CONNECT",
  "state": {
    "name": "PENDING",
    "description": "The call is progressing normally..."
  },
  "callall_fastest_contact": null,
  "callall_callgroup": null,
  "confirmed_call": [],
  "calls": [],
  "leg_a": [
    {
      "number": "27821234567",
      "name": "Jane Smith",
      "reference": "agent1",
      "confirmed": false,
      "bridged": false,
      "order": 1,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    }
  ],
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe",
      "reference": "",
      "confirmed": false,
      "bridged": false,
      "order": 1,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    }
  ]
}

Distribution: CALL_ALL

All leg_a numbers are called simultaneously. The first agent to answer and press 1 is connected to leg B. Requires at least 1 A-leg.

Request

JSON
{
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "whisper": "A potential customer has shown interest in your Citi Golf",
  "recorded": true,
  "reference": "lead-ref-2024-001",
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "call_distribution": "CALL_ALL",
  "connect_type": "LEAD_CONNECT",
  "leg_a": [
    {
      "number": "27821234567",
      "name": "Jane Smith",
      "reference": "agent1"
    },
    {
      "number": "27821234568",
      "name": "Bob Jones",
      "reference": "agent2"
    },
    {
      "number": "27821234569",
      "name": "Sam Lee",
      "reference": "agent3"
    }
  ],
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe"
    }
  ]
}

Response — 201 Created

JSON
{
  "url": "https://next.logimeter.com/v1/connect/1ab5579f-88af-4873-9433-b595a8d5738d/",
  "uuid": "1ab5579f-88af-4873-9433-b595a8d5738d",
  "reference": "lead-ref-2024-001",
  "create_stamp": "2024-08-08T09:56:23.915931Z",
  "modify_stamp": "2024-08-08T09:56:23.915931Z",
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "whisper": "A potential customer has shown interest in your Citi Golf",
  "recorded": true,
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "partner": {
    "name": "your-partner"
  },
  "call_distribution": "CALL_ALL",
  "connect_type": "LEAD_CONNECT",
  "state": {
    "name": "PENDING",
    "description": "The call is progressing normally..."
  },
  "callall_fastest_contact": null,
  "callall_callgroup": null,
  "confirmed_call": [],
  "calls": [],
  "leg_a": [
    {
      "number": "27821234567",
      "name": "Jane Smith",
      "reference": "agent1",
      "confirmed": false,
      "bridged": false,
      "order": 1,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    },
    {
      "number": "27821234568",
      "name": "Bob Jones",
      "reference": "agent2",
      "confirmed": false,
      "bridged": false,
      "order": 2,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    },
    {
      "number": "27821234569",
      "name": "Sam Lee",
      "reference": "agent3",
      "confirmed": false,
      "bridged": false,
      "order": 3,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    }
  ],
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe",
      "reference": "",
      "confirmed": false,
      "bridged": false,
      "order": 1,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    }
  ]
}

Distribution: HEAD_START

One random leg_a is called first; others are delayed (default 10 seconds, configurable per system/partner/company). First to answer and press 1 wins.

Request

JSON
{
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "whisper": "A potential customer has shown interest in your Citi Golf",
  "recorded": true,
  "reference": "lead-ref-2024-001",
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "call_distribution": "HEAD_START",
  "connect_type": "LEAD_CONNECT",
  "leg_a": [
    {
      "number": "27821234567",
      "name": "Jane Smith",
      "reference": "agent1"
    },
    {
      "number": "27821234568",
      "name": "Bob Jones",
      "reference": "agent2"
    },
    {
      "number": "27821234569",
      "name": "Sam Lee",
      "reference": "agent3"
    }
  ],
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe"
    }
  ]
}

Response — 201 Created

JSON
{
  "url": "https://next.logimeter.com/v1/connect/1ab5579f-88af-4873-9433-b595a8d5738d/",
  "uuid": "1ab5579f-88af-4873-9433-b595a8d5738d",
  "reference": "lead-ref-2024-001",
  "create_stamp": "2024-08-08T09:56:23.915931Z",
  "modify_stamp": "2024-08-08T09:56:23.915931Z",
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "whisper": "A potential customer has shown interest in your Citi Golf",
  "recorded": true,
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "partner": {
    "name": "your-partner"
  },
  "call_distribution": "HEAD_START",
  "connect_type": "LEAD_CONNECT",
  "state": {
    "name": "PENDING",
    "description": "The call is progressing normally..."
  },
  "callall_fastest_contact": null,
  "callall_callgroup": null,
  "confirmed_call": [],
  "calls": [],
  "leg_a": [
    {
      "number": "27821234567",
      "name": "Jane Smith",
      "reference": "agent1",
      "confirmed": false,
      "bridged": false,
      "order": 1,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    },
    {
      "number": "27821234568",
      "name": "Bob Jones",
      "reference": "agent2",
      "confirmed": false,
      "bridged": false,
      "order": 2,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    },
    {
      "number": "27821234569",
      "name": "Sam Lee",
      "reference": "agent3",
      "confirmed": false,
      "bridged": false,
      "order": 3,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    }
  ],
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe",
      "reference": "",
      "confirmed": false,
      "bridged": false,
      "order": 1,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    }
  ]
}

Distribution: SEQUENTIAL

A-legs are dialled in order sequence. Between 1 and N agents (N = company max, default 10). When using order, every leg must have a unique value >= 1.

Request

JSON
{
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "whisper": "A potential customer has shown interest in your Citi Golf",
  "recorded": true,
  "reference": "lead-ref-2024-001",
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "call_distribution": "SEQUENTIAL",
  "connect_type": "LEAD_CONNECT",
  "leg_a": [
    {
      "number": "27821234567",
      "name": "Jane Smith",
      "reference": "agent1",
      "order": 1
    },
    {
      "number": "27821234568",
      "name": "Bob Jones",
      "reference": "agent2",
      "order": 2
    }
  ],
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe"
    }
  ]
}

Response — 201 Created

JSON
{
  "url": "https://next.logimeter.com/v1/connect/1ab5579f-88af-4873-9433-b595a8d5738d/",
  "uuid": "1ab5579f-88af-4873-9433-b595a8d5738d",
  "reference": "lead-ref-2024-001",
  "create_stamp": "2024-08-08T09:56:23.915931Z",
  "modify_stamp": "2024-08-08T09:56:23.915931Z",
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "whisper": "A potential customer has shown interest in your Citi Golf",
  "recorded": true,
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "partner": {
    "name": "your-partner"
  },
  "call_distribution": "SEQUENTIAL",
  "connect_type": "LEAD_CONNECT",
  "state": {
    "name": "PENDING",
    "description": "The call is progressing normally..."
  },
  "callall_fastest_contact": null,
  "callall_callgroup": null,
  "confirmed_call": [],
  "calls": [],
  "leg_a": [
    {
      "number": "27821234567",
      "name": "Jane Smith",
      "reference": "agent1",
      "confirmed": false,
      "bridged": false,
      "order": 1,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    },
    {
      "number": "27821234568",
      "name": "Bob Jones",
      "reference": "agent2",
      "confirmed": false,
      "bridged": false,
      "order": 2,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    }
  ],
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe",
      "reference": "",
      "confirmed": false,
      "bridged": false,
      "order": 1,
      "dial_stamp": null,
      "answer_stamp": null,
      "end_stamp": null
    }
  ]
}

Optional leg_a via vehicle

Omit leg_a and supply vehicle.new_used with CALL_ALL, HEAD_START, or SEQUENTIAL. Logimeter resolves agents from the company's configured call group.

Request

JSON
{
  "call_term_callbacks": [
    "https://your-server.com/connect/callbacks/"
  ],
  "reference": "lead-ref-vehicle-001",
  "company": {
    "name": "Trask Industries",
    "reference": "6e7d1f48-2ca1-4ef4-a433-a3fa765ff190"
  },
  "call_distribution": "CALL_ALL",
  "connect_type": "LEAD_CONNECT",
  "vehicle": {
    "new_used": "NEW"
  },
  "leg_b": [
    {
      "number": "27831112222",
      "name": "John Doe"
    }
  ]
}

Requires call group configuration on the company in Logimeter. See Fields → Optional leg_a.