Skip to content

Instantly share code, notes, and snippets.

@tylerlong
Last active May 13, 2016 07:08
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save tylerlong/44a982dc0636fed8ee0a7d015a84158b to your computer and use it in GitHub Desktop.
Save tylerlong/44a982dc0636fed8ee0a7d015a84158b to your computer and use it in GitHub Desktop.
documentation bugs

Leg Info

result attribute:

'Unknown' | 'ResultInProgress' | 'Missed' | 'Call accepted' | 'Voicemail' | 'Rejected' | 'Reply' | 'Received' | 'Receive Error' | 'Fax on Demand' | 'Partial Receive' | 'Blocked' | 'Call connected' | 'No Answer' | 'International Disabled' | 'Busy' | 'Send Error' | 'Sent' | 'No fax machine' | 'ResultEmpty' | 'Account ' | 'Suspended' | 'Call Failed' | 'Call Failure' | 'Internal Error' | 'IP Phone offline' | 'Restricted Number' | 'Wrong Number' | 'Stopped' | 'Hang up' | 'Poor Line Quality' | 'Partially Sent' | 'International Disabled' | 'International Restriction' | 'Abandoned' | 'Declined' | 'Fax Receipt Error' | 'Fax Send Error'

International Disabled appears twice.

Call Log Record

Save issue as above

Call Log Info

Save issue as above

SIP Info

No doc for GET /restapi/{version}/account/~/device/sip-info

Device

No doc for PUT /restapi/v1.0/account/{accountId}/device/{deviceId}

Address book

Get Address Book, response body

Collection Personal Contact Info should be Collection of Personal Contact Info

Answering rule

No doc for GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/after-hours-rule No doc for GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/business-hours-rule

assigned role

No doc for GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/assigned-role

authz profile

No doc for GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile

No doc for GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check

Blocked Number Info

uri property no description

Pager Message

No doc for "Get Pager Message List" GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager

No doc for "Get Pager Message by ID" GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager/{companyPagerId}

Fax Message

No Doc for "Get Fax Message List" GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax

No Doc for "Get Fax Message by ID" /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax/{faxId}

Presence

No Doc for "Update Extension Presence" PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence

Profile Image

Update Extension Profile Image. The doc says response is Binary data image, the example is HTTP/1.1 204 No Content. Contradictory.

SMS

No Doc for "Get SMS Message List" GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/sms

No Doc for "Get SMS Message by ID" GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/sms/{smsId}

Payment

No Doc for GET/PUT /restapi/v1.0/account/{accountId}/payment-info

Custom Data

No Doc for GET "Get Custom Data by Key" /restapi/v1.0/client-info/custom-data/{customDataKey}

path parameter my-custom-key, type should be string instead of integer.

Dictionary

No Doc for GET "Get Brand by ID" /restapi/v1.0/dictionary/brand/{brandId} No Doc for GET "Get Service Plan by ID" /restapi/v1.0/dictionary/service-plan/{servicePlanId}

Service Info

"Get Account Service Info" /restapi/v1.0/account/{accountId}/service-info

Table Account Limits no Type column. Add Type column and all three records are of the type integer.

Get Extension Profile Image

scaleSize '90x90' | '195'x'195' | '584'x'584' should be changed to scaleSize '90x90' | '195x195' | '584x584'

scaleSize description Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then. Then what? Something is missing.

Business Address

/restapi/v1.0/account/{accountId}/business-address "Update Company Business Address"

The response body is NOT AccountInfo. It is something like:

Name Type
uri string
company string
email string
businessAddress BusinessAddressInfo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment