search

sipgate / sipgate.io

Create custom telephony integration solutions. Play audio files, manage your devices, reject the call, present dial tone menus or just create statistics. Adapt telephony to your business needs, control your home automation with your phone or just create that funny hack to make using the phone more enjoyable. @sipgate.io, https://twitter.com/sipgateio
https://www.sipgate.io
Other
202 stars 32 forks source link

Improved field description #120

Closed sieppl closed 7 years ago

sieppl commented 7 years ago

I was missing from the documenation an overview what values are possible for example for "cause" and in general what type and length to be expected. At the moment developeres have to guess how long a callId can become. Can you please update the readme?

codedrift commented 7 years ago

Hey @sieppl The possible causes (e.g. for hangup) are listed in the readme already: https://github.com/sipgate/sipgate.io#hangup-causes To be up to date we recommend our new developer portal where you can find the causes as well: https://developer.sipgate.io/v1.0/reference#hangup-causes-1 The type of these causes will always be a string.

The callIds are variable in length as of now. To be safe i would recommend a length of at least 200 characters or a variable length if possible. Please note that the length and form of a callId might change in the future.

sieppl commented 7 years ago

Hi,

I was also asking for a better description of every field content, e.g. "string, length 200 chars" etc. This should be in the readme!

Kind regards Sebastian

codedrift commented 7 years ago

Alright. Thanks for the clarification. As we are continuously improving our documentation we certainly will take this into consideration.

Regards Peter