Loading...
Loading...
Look up phone number information (carrier, type, caller name) and verify users via SMS/voice OTP. Use for phone verification and data enrichment. This skill provides JavaScript SDK examples.
npx skill4agent add team-telnyx/telnyx-ext-agent-skills telnyx-verify-javascriptnpm install telnyximport Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});clientGET /number_lookup/{phone_number}const numberLookup = await client.numberLookup.retrieve('+18665552368');
console.log(numberLookup.data);POST /verifications/callphone_numberverify_profile_idconst createVerificationResponse = await client.verifications.triggerCall({
phone_number: '+13035551234',
verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292',
});
console.log(createVerificationResponse.data);POST /verifications/flashcallphone_numberverify_profile_idconst createVerificationResponse = await client.verifications.triggerFlashcall({
phone_number: '+13035551234',
verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292',
});
console.log(createVerificationResponse.data);POST /verifications/smsphone_numberverify_profile_idconst createVerificationResponse = await client.verifications.triggerSMS({
phone_number: '+13035551234',
verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292',
});
console.log(createVerificationResponse.data);GET /verifications/{verification_id}const verification = await client.verifications.retrieve('12ade33a-21c0-473b-b055-b3c836e1c292');
console.log(verification.data);POST /verifications/{verification_id}/actions/verifyconst verifyVerificationCodeResponse = await client.verifications.actions.verify(
'12ade33a-21c0-473b-b055-b3c836e1c292',
);
console.log(verifyVerificationCodeResponse.data);GET /verifications/by_phone_number/{phone_number}const byPhoneNumbers = await client.verifications.byPhoneNumber.list('+13035551234');
console.log(byPhoneNumbers.data);POST /verifications/by_phone_number/{phone_number}/actions/verifycodeverify_profile_idconst verifyVerificationCodeResponse = await client.verifications.byPhoneNumber.actions.verify(
'+13035551234',
{ code: '17686', verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292' },
);
console.log(verifyVerificationCodeResponse.data);GET /verify_profiles// Automatically fetches more pages as needed.
for await (const verifyProfile of client.verifyProfiles.list()) {
console.log(verifyProfile.id);
}POST /verify_profilesnameconst verifyProfileData = await client.verifyProfiles.create({ name: 'Test Profile' });
console.log(verifyProfileData.data);GET /verify_profiles/{verify_profile_id}const verifyProfileData = await client.verifyProfiles.retrieve(
'12ade33a-21c0-473b-b055-b3c836e1c292',
);
console.log(verifyProfileData.data);PATCH /verify_profiles/{verify_profile_id}const verifyProfileData = await client.verifyProfiles.update(
'12ade33a-21c0-473b-b055-b3c836e1c292',
);
console.log(verifyProfileData.data);DELETE /verify_profiles/{verify_profile_id}const verifyProfileData = await client.verifyProfiles.delete(
'12ade33a-21c0-473b-b055-b3c836e1c292',
);
console.log(verifyProfileData.data);GET /verify_profiles/templatesconst response = await client.verifyProfiles.retrieveTemplates();
console.log(response.data);POST /verify_profiles/templatestextconst messageTemplate = await client.verifyProfiles.createTemplate({
text: 'Your {{app_name}} verification code is: {{code}}.',
});
console.log(messageTemplate.data);PATCH /verify_profiles/templates/{template_id}textconst messageTemplate = await client.verifyProfiles.updateTemplate(
'12ade33a-21c0-473b-b055-b3c836e1c292',
{ text: 'Your {{app_name}} verification code is: {{code}}.' },
);
console.log(messageTemplate.data);