Skip to content

Commit 173f567

Browse files
authored
Correction to SIP docs (#181)
"X-" prefix for custom headers no longer required
1 parent f0592a9 commit 173f567

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/main/java/com/opentok/SipProperties.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,15 @@ public Builder password(String password) {
110110

111111
/**
112112
* Call this method to define custom headers to be added to the SIP ​INVITE​
113-
* initiated from OpenTok to the your SIP platform.
113+
* initiated from OpenTok to your SIP platform.
114114
*
115115
* @param headersJsonStartingWithXDash This JSON string defines custom headers
116-
* to be added to the SIP ​INVITE​ request initiated from OpenTok to the your SIP platform.
117-
* Each of the custom headers must start with the ​"X-"​ prefix, or the call will result
118-
* in a Bad Request (400) response.
116+
* to be added to the SIP ​INVITE​ request initiated from OpenTok to your SIP platform.
117+
* <p>
118+
* <b>Note:</b> You no longer need to append the ​"X-"​ prefix to the beginning of
119+
* custom headers. This restriction, which applied previously, has been removed.
119120
*
120-
* @return The SipProperties.Builder object with the custom headers set.
121+
* @return The SipProperties.Builder object.
121122
*/
122123
public Builder headersJsonStartingWithXDash(String headersJsonStartingWithXDash) {
123124
this.headersJsonStartingWithXDash = headersJsonStartingWithXDash;

0 commit comments

Comments
 (0)