You can call this operation to obtain the invitation link.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeFabricInvitationCode

The operation that you want to perform. Set the value to DescribeFabricInvitationCode.

ConsortiumId String Yes consortium-lianmenyumingyi-hc5d1bwl

The ID of the consortium.
RegionId String No cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
DynamicCode String InvitationCodeNotFound

The error identifier.
DynamicMessage String The invitation code could not found.

The error message.
ErrorCode Integer 200

The error code.
RequestId String 77E25463-56CB-4F1C-8EB6-8ADDFE39EF0F

The ID of the API request.
Result

The list of the invitation links.
Accepted Boolean true

Indicates whether the invitation is accepted. A value of true indicates that the invitation is accepted. A value of false indicates that the invitation is not accepted.

Code String code

The invitation code.
ConsortiumId String consortium-lianmenyumingyi-hc5d1bwlulg7

The ID of the consortium.
Email String abc@126.com

The Email address.
ExpireTime String 1544411108000

The expiration time..
InvitationId Integer 2

The invitation ID.
SendTime String 1544411108000

The time when the invitation was sent.
SenderBid String 27534

The business ID of the user who sent the invitation.
SenderId Long 26345345

The ID of the user who sent the invitation.
SenderName String uid-35324

The user who sent the invitation.
Url String https://baas.console.aliyun.test/invite?code=92e7ef1934892

The invitation link.
Success Boolean true

Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeFabricInvitationCode&ConsortiumId=consortium-lianmenyumingyi-hc5d1bwl&<Common request parameters>

Successful response examples

XML format 

<DescribeFabricInvitationCodeResponse>  <Result>            <Url>https://baas.console.aliyun.test/invite?code=92e7ef1934892f272537d750c743a3d1be773038c97a8414065d63551a742b81</Url&gt;            <ExpireTime>2018-06-14T15:10:11.000+0000</ExpireTime>            <Accepted>true</Accepted>            <Code>code</Code>            <ConsortiumId>consortium-lianmenyumingyi-hc5d1bwlulg7</ConsortiumId>            <Email>abc@126.com</Email>            <InvitationId>2</InvitationId>            <SendTime>2018-06-14T15:10:11.000+0000</SendTime>            <SenderId>126467457</SenderId>            <SenderBid>3563</SenderBid>            <SenderName>name</SenderName>      </Result>      <RequestId>9CFDE6E9-3835-4C2E-BECD-7CF20F5B5DD7</RequestId>      <Success>true</Success>      <ErrorCode>200</ErrorCode></DescribeFabricInvitationCodeResponse>

JSON format 

{    “Result”:{        “SenderBid”:”3563”,        “Email”:”abc@126.com”,        “ConsortiumId”:”consortium-lianmenyumingyi-hc5d1bwlulg7”,        “Url”:”https://baas.console.aliyun.test/invite?code=92e7ef1934892f272537d750c743a3d1be773038c97a8414065d63551a742b81“,        “InvitationId”:2,        “Accepted”:”true”,        “ExpireTime”:”2018-06-14T15:10:11.000+0000”,        “SendTime”:”2018-06-14T15:10:11.000+0000”,        “SenderId”:126467457,        “SenderName”:”name”,        “Code”:”code”    },    “RequestId”:”9CFDE6E9-3835-4C2E-BECD-7CF20F5B5DD7”,    “ErrorCode”:200,    “Success”:true}

Error codes

For more information about error codes, see Error codes. 

     </article>
  </main>