(phoneNumbers())
- create - Create a phone number
- get - Retrieve a phone number
- delete - Delete a phone number
- update - Update a phone number
Create a new phone number
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.SDKError;
import com.clerk.backend_api.models.operations.CreatePhoneNumberRequestBody;
import com.clerk.backend_api.models.operations.CreatePhoneNumberResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
CreatePhoneNumberRequestBody req = CreatePhoneNumberRequestBody.builder()
.build();
CreatePhoneNumberResponse res = sdk.phoneNumbers().create()
.request(req)
.call();
if (res.phoneNumber().isPresent()) {
// handle response
}
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
// handle exception
throw e;
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}
CreatePhoneNumberResponse
Error Object |
Status Code |
Content Type |
models/errors/ClerkErrors |
400,401,403,404,422 |
application/json |
models/errors/SDKError |
4xx-5xx |
*/* |
Returns the details of a phone number
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.SDKError;
import com.clerk.backend_api.models.operations.GetPhoneNumberResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
GetPhoneNumberResponse res = sdk.phoneNumbers().get()
.phoneNumberId("<value>")
.call();
if (res.phoneNumber().isPresent()) {
// handle response
}
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
// handle exception
throw e;
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}
Parameter |
Type |
Required |
Description |
phoneNumberId |
String |
✔️ |
The ID of the phone number to retrieve |
GetPhoneNumberResponse
Error Object |
Status Code |
Content Type |
models/errors/ClerkErrors |
400,401,403,404 |
application/json |
models/errors/SDKError |
4xx-5xx |
*/* |
Delete the phone number with the given ID
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.SDKError;
import com.clerk.backend_api.models.operations.DeletePhoneNumberResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
DeletePhoneNumberResponse res = sdk.phoneNumbers().delete()
.phoneNumberId("<value>")
.call();
if (res.deletedObject().isPresent()) {
// handle response
}
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
// handle exception
throw e;
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}
Parameter |
Type |
Required |
Description |
phoneNumberId |
String |
✔️ |
The ID of the phone number to delete |
DeletePhoneNumberResponse
Error Object |
Status Code |
Content Type |
models/errors/ClerkErrors |
400,401,403,404 |
application/json |
models/errors/SDKError |
4xx-5xx |
*/* |
Updates a phone number
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.SDKError;
import com.clerk.backend_api.models.operations.UpdatePhoneNumberRequestBody;
import com.clerk.backend_api.models.operations.UpdatePhoneNumberResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
UpdatePhoneNumberResponse res = sdk.phoneNumbers().update()
.phoneNumberId("<value>")
.requestBody(UpdatePhoneNumberRequestBody.builder()
.build())
.call();
if (res.phoneNumber().isPresent()) {
// handle response
}
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
// handle exception
throw e;
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}
Parameter |
Type |
Required |
Description |
phoneNumberId |
String |
✔️ |
The ID of the phone number to update |
requestBody |
Optional |
➖ |
N/A |
UpdatePhoneNumberResponse
Error Object |
Status Code |
Content Type |
models/errors/ClerkErrors |
400,401,403,404 |
application/json |
models/errors/SDKError |
4xx-5xx |
*/* |