I/O Docs: API Documentation

• Group Methods (Group Authentication Required)

  • List Methods
  • Expand Methods

  • GET Get Group Details /sandbox/v1/groups/:group_id

    Get information about a group.

    Parameter	Value	Type	Description
    :group_id		string	The group ID.

  • POST Create Child Group /sandbox/v1/groups/:group_id/groups

    Creates a child group under the given group_id.

    Parameter	Value	Type	Description
    :group_id		string	The group ID.
    Content-Type		string	Content type of the payload

    Request Body

    {"name":"My Group","label":"Group Label","time_zone":"Australia/Melbourne","phone":"61455556666","address":{"address":"Testing St","suburb":"Testville","country":"AU","state":"VIC","postcode":"3205"}}

    {"name":"My Group","label":"Group Label","time_zone":"Australia/Melbourne","phone":"61455556666","address":{"address":"Testing St","suburb":"Testville","country":"AU","state":"VIC","postcode":"3205"}}
  • POST Create Account /sandbox/v1/accounts

    Creates an account. Group can be passed in, or will use authenticated group if not provided.

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload

    Request Body

    {"name":"My Account","dubber_address":"myaccount","time_zone":"Australia/Melbourne","phone":"61455556666","address":{"address":"Testing St","suburb":"Testville","country":"AU","state":"VIC","postcode":"3205"}}

    {"name":"My Account","dubber_address":"myaccount","time_zone":"Australia/Melbourne","phone":"61455556666","address":{"address":"Testing St","suburb":"Testville","country":"AU","state":"VIC","postcode":"3205"}}
  • GET Get Group Unidentified Recordings /sandbox/v1/groups/:group_id/unidentified_recordings

    Get group unidentified recordings.

    Parameter	Value	Type	Description
    :group_id		string	The group ID.
    before_id		string	Return recordings before this recording ID
    after_id		string	Return recordings after this recording ID
    count		int	Total recordings to return. Maximum 100
    query		string	String to search
    page		int	Page number to return. Can't be used when sending before_id and after_id

  • POST Create Group Unidentified Recording /sandbox/v1/groups/:group_id/unidentified_recordings

    Creates an unidentified recording in the grouo.

    Parameter	Value	Type	Description
    :group_id		string	The group ID.
    Content-Type		string	Content type of the payload

    Request Body

    { "to":"61422331122","from":"61422331123","call_type":"inbound","start_time":"Thu, 22 Aug 2013 11:39:12 +1000","end_time":"Thu, 22 Aug 2013 11:40:12 +1000","recording_url":"https://s3-ap-southeast-2.amazonaws.com/mashery-poc/sample.mp3"}

    { "to":"61422331122","from":"61422331123","call_type":"inbound","start_time":"Thu, 22 Aug 2013 11:39:12 +1000","end_time":"Thu, 22 Aug 2013 11:40:12 +1000","recording_url":"https://s3-ap-southeast-2.amazonaws.com/mashery-poc/sample.mp3"}

• Account Methods

  • List Methods
  • Expand Methods

  • GET Get Account Details /sandbox/v1/accounts/:account_id

    Get information about an account.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.

  • PUT Update Account Details /sandbox/v1/accounts/:account_id

    Update information about an account.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.
    Content-Type		string	Content type of the payload

    Request Body

    {"name": "Mashery","dubber_address": "mashery","time_zone": "Australia/Melbourne","address": {"address": "717 Market Street, Suite 300","suburb": "San Francisco","state": "VIC","post_code": "3205","country": "AU"},"phone": "134444"}

    {"name": "Mashery","dubber_address": "mashery","time_zone": "Australia/Melbourne","address": {"address": "717 Market Street, Suite 300","suburb": "San Francisco","state": "VIC","post_code": "3205","country": "AU"},"phone": "134444"}

• Recording Methods

  • List Methods
  • Expand Methods

  • GET Get Account Recordings /sandbox/v1/accounts/:account_id/recordings

    Get account recordings.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.
    before_id		string	Return recordings before this recording ID
    after_id		string	Return recordings after this recording ID
    count		int	Total recordings to return. Maximum 100
    query		string	String to search
    page		int	Page number to return. Can't be used when sending before_id and after_id

  • POST Create Recording /sandbox/v1/accounts/:account_id/recordings

    Creates a recording in the account.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.
    Content-Type		string	Content type of the payload

    Request Body

    { "to":"61422331122","from":"61422331123","call_type":"inbound","start_time":"Thu, 22 Aug 2013 11:39:12 +1000","end_time":"Thu, 22 Aug 2013 11:40:12 +1000","recording_url":"https://s3-ap-southeast-2.amazonaws.com/mashery-poc/sample.mp3"}

    { "to":"61422331122","from":"61422331123","call_type":"inbound","start_time":"Thu, 22 Aug 2013 11:39:12 +1000","end_time":"Thu, 22 Aug 2013 11:40:12 +1000","recording_url":"https://s3-ap-southeast-2.amazonaws.com/mashery-poc/sample.mp3"}
  • GET Get Recording Details /sandbox/v1/recordings/:recording_id

    Gets a specified recording.

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID
    listener		string	Username (email) of the user making the call. Providing this value will return a link to the recording.
    content_disposition		string	The content disposition for the recording_url (is not provided defaults to inline)

  • GET Get Recording Waveform /sandbox/v1/recordings/:recording_id/waveform

    Gets the waveform link for a specified recording.

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID

  • DELETE Delete Recording /sandbox/v1/recordings/:recording_id

    Deletes a specified recording.

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID

  • PUT Update Recording Metadata /sandbox/v1/recordings/:recording_id/metadata

    Updated the metadata for a specified recording.

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID
    Content-Type		string	Content type of the payload

    Request Body

    { "key_one":"value_one","key_two":"value_two" }

    { "key_one":"value_one","key_two":"value_two" }
  • POST Add Recording Tags /sandbox/v1/recordings/:recording_id/tags

    Add tags to a specified recording.

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID
    Content-Type		string	Content type of the payload

    Request Body

    { "tags":["tag_one","tag_two"] }

    { "tags":["tag_one","tag_two"] }
  • DELETE Delete Recording Tags /sandbox/v1/recordings/:recording_id/tags

    Deletes all tags from a specified recording.

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID

• Multipart Recording Methods

  • List Methods
  • Expand Methods

  • POST Create Multipart Recording /sandbox/v1/accounts/:account_id/recordings

    Creates a recording in the account.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.
    Content-Type		string	Content type of the payload

    Request Body

    { "to":"61422331122","from":"61422331123","call_type":"inbound","start_time":"Thu, 22 Aug 2013 11:39:12 +1000","end_time":"Thu, 22 Aug 2013 11:40:12 +1000","recording_name":"multipart.mp3"}

    { "to":"61422331122","from":"61422331123","call_type":"inbound","start_time":"Thu, 22 Aug 2013 11:39:12 +1000","end_time":"Thu, 22 Aug 2013 11:40:12 +1000","recording_name":"multipart.mp3"}
  • GET Get Recording Upload Part /sandbox/v1/recordings/:recording_id/upload

    Gets the details to upload a part of a recording.

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID
    part_number		string	The part_number to get upload details for
    content_md5		string	The MD5 digest of the content for the part. This value must also be Base64 encoded
    content_sha256		string	The SHA256 hex digest of the content for the part

  • PUT Put Complete Multipart Recording Upload /sandbox/v1/recordings/:recording_id/complete_upload

    Completes the multipart upload for a recording

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID
    Content-Type		string	Content type of the payload

    Request Body

    { "parts":[{"part_number":"1","e_tag":"26a8a9c355301c288e45a91b500bfdfa"}]}

    { "parts":[{"part_number":"1","e_tag":"26a8a9c355301c288e45a91b500bfdfa"}]}
  • DELETE Abort Multipart Recording Upload /sandbox/v1/recordings/:recording_id

    Deletes a specified recording/Aborts the multipart upload.

    Parameter	Value	Type	Description
    :recording_id		string	The recording ID

• User Methods

  • List Methods
  • Expand Methods

  • GET Get Account Users /sandbox/v1/accounts/:account_id/users

    Get account users.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.

  • POST Create Account User /sandbox/v1/accounts/:account_id/users

    Creates a user in the account. It will send an email address to the user to activate the account.

    Parameter	Value	Type	Description
    :account_id		string	The account ID where the user will be created.
    Content-Type		string	Content type of the payload

    Request Body

    { "role":"Standard User","email":"email@email.com","first_name":"Firstname","last_name":"LastName","mobile_number":"61212345678"}

    { "role":"Standard User","email":"email@email.com","first_name":"Firstname","last_name":"LastName","mobile_number":"61212345678"}
  • GET Get User Details /sandbox/v1/users/:user_id

    Gets a specified user.

    Parameter	Value	Type	Description
    :user_id		string	The user ID

  • DELETE Delete User /sandbox/v1/users/:user_id

    Deletes a specified user.

    Parameter	Value	Type	Description
    :user_id		string	The user ID

  • PUT Update User /sandbox/v1/users/:user_id

    Edit user details.

    Parameter	Value	Type	Description
    :user_id		string	The user ID
    Content-Type		string	Content type of the payload

    Request Body

    { "first_name":"New Name"}

    { "first_name":"New Name"}

• Profile Methods

  • List Methods
  • Expand Methods

  • GET Get Profile /sandbox/v1/profile

    Gets the authenticated profile

• Notification (Rest Hook) Methods

  • List Methods
  • Expand Methods

  • POST Create Group Notification (Group Authentication Only) /sandbox/v1/groups/:group_id/notifications

    Creates a notification for the given group.

    Parameter	Value	Type	Description
    :group_id		string	The group ID.
    Content-Type		string	Content type of the payload

    Request Body

    {"post_url":"https://myrestserver.com/resthooks","event_type":"recording.create"}

    {"post_url":"https://myrestserver.com/resthooks","event_type":"recording.create"}
  • GET Get Group Notifications (Group Authentication Only) /sandbox/v1/groups/:group_id/notifications

    Gets the list of notifications for the given group.

    Parameter	Value	Type	Description
    :group_id		string	The group ID.

  • POST Create Account Notification /sandbox/v1/accounts/:account_id/notifications

    Creates a notification for the given account.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.
    Content-Type		string	Content type of the payload

    Request Body

    {"post_url":"https://myrestserver.com/resthooks","event_type":"recording.create"}

    {"post_url":"https://myrestserver.com/resthooks","event_type":"recording.create"}
  • GET Get Account Notifications /sandbox/v1/accounts/:account_id/notifications

    Gets the list of notifications for the given account.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.

  • GET Get Notification Details /sandbox/v1/notifications/:notification_id

    Gets information about a given notification

    Parameter	Value	Type	Description
    :notification_id		string	The notification ID.

  • PUT Update Notification /sandbox/v1/notifications/:notification_id

    Update information about a given notification

    Parameter	Value	Type	Description
    :notification_id		string	The notification ID.
    Content-Type		string	Content type of the payload

    Request Body

    {"post_url":"https://myrestserver.com/resthooks","event_type":"recording.create"}

    {"post_url":"https://myrestserver.com/resthooks","event_type":"recording.create"}
  • POST Activate Notification /sandbox/v1/notifications/:notification_id/activate

    Activates the given notification, using delayed activation

    Parameter	Value	Type	Description
    :notification_id		string	The notification ID.
    X-Hook-Secret		string	The secret sent to activate the notification
    Content-Type		string	Content type of the payload

    Request Body

    {}

    {}
  • GET Release Unclaimed Notification /sandbox/v1/notifications/:notification_id/unclaimed

    Releases any unclaimed notifications for the given notification

    Parameter	Value	Type	Description
    :notification_id		string	The notification ID.

  • DELETE Delete Notification /sandbox/v1/notifications/:notification_id

    Deletes the given notification

    Parameter	Value	Type	Description
    :notification_id		string	The notification ID.

• Dub.Point (Group Authentication Required)

  • List Methods
  • Expand Methods

  • GET Get Account dub.points /sandbox/v1/accounts/:account_id/dub_points

    Get account dub.points.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.

  • POST Create Account dub.point /sandbox/v1/accounts/:account_id/dub_points

    Creates a dub.point for the given account.

    Parameter	Value	Type	Description
    :account_id		string	The account ID.
    Content-Type		string	Content type of the payload

    Request Body

    {"user":"my-user-id","type":"Recorder","product":"Reserved","external_type":"broadworks","service_provider":"My-Provider","external_group":"My-Group","external_identifier":"unique-user@my-provider.com"}

    {"user":"my-user-id","type":"Recorder","product":"Reserved","external_type":"broadworks","service_provider":"My-Provider","external_group":"My-Group","external_identifier":"unique-user@my-provider.com"}
  • GET Get dub.point Details /sandbox/v1/dub_points/:dub_point_id

    Gets information about a given dub.point

    Parameter	Value	Type	Description
    :dub_point_id		string	The dub.point ID.

  • GET Find dub.point /sandbox/v1/dub_points/find

    Finds a matching dub.points

    Parameter	Value	Type	Description
    Content-Type		string	Content type of the payload

    Request Body

    {"external_type":"broadworks","service_provider":"My-Provider","external_group":"My-Group","external_identifier":"unique-user@my-provider.com"}

    {"external_type":"broadworks","service_provider":"My-Provider","external_group":"My-Group","external_identifier":"unique-user@my-provider.com"}

• OAuth 2 Methods

  • List Methods
  • Expand Methods

  • POST Revoke Access Token /sandbox/v1/revoke

    Revokes an access token.

    Parameter	Value	Type	Description
    client_id		string	Client ID value the token to revoke belongs to.
    token		string	Token to be revoked.